From a39adb3ff0979a46c953f3555874f31669cf1950 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Tue, 2 Mar 2021 13:48:05 +0100 Subject: [PATCH 01/56] bump version to 2.1.0-dev --- galaxy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/galaxy.yml b/galaxy.yml index 43b8a428..1462ad40 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -62,7 +62,7 @@ authors: - "metalcated " - "russianguppie <46544650+russianguppie@users.noreply.github.com>" - "willtome " -version: "2.0.1" +version: "2.1.0-dev" license: - "GPL-3.0-or-later" tags: From 574b520c59fe4983780576aa60169a7f3cd22331 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Tue, 23 Feb 2021 08:47:06 +0100 Subject: [PATCH 02/56] add bindep definition for RPM bindings ansible-builder can use bindep to create a working Execution Environment based on system packages, which we can benefit from by including RPM bindings there, as those are hard to install from PyPI. [1] https://ansible-builder.readthedocs.io/en/latest/definition.html --- Makefile | 2 +- bindep.txt | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 bindep.txt diff --git a/Makefile b/Makefile index 02b754dc..96621fb9 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ MANIFEST := build/collections/ansible_collections/$(NAMESPACE)/$(NAME)/MANIFEST. ROLES := $(wildcard roles/*) PLUGIN_TYPES := $(filter-out __%,$(notdir $(wildcard plugins/*))) -METADATA := galaxy.yml LICENSE README.md meta/runtime.yml requirements.txt changelogs/changelog.yaml CHANGELOG.rst +METADATA := galaxy.yml LICENSE README.md meta/runtime.yml requirements.txt changelogs/changelog.yaml CHANGELOG.rst bindep.txt $(foreach PLUGIN_TYPE,$(PLUGIN_TYPES),$(eval _$(PLUGIN_TYPE) := $(filter-out %__init__.py,$(wildcard plugins/$(PLUGIN_TYPE)/*.py)))) DEPENDENCIES := $(METADATA) $(foreach PLUGIN_TYPE,$(PLUGIN_TYPES),$(_$(PLUGIN_TYPE))) $(foreach ROLE,$(ROLES),$(wildcard $(ROLE)/*/*)) $(foreach ROLE,$(ROLES),$(ROLE)/README.md) diff --git a/bindep.txt b/bindep.txt new file mode 100644 index 00000000..d7ec340d --- /dev/null +++ b/bindep.txt @@ -0,0 +1,2 @@ +python3-rpm [(platform:redhat platform:base-py3)] +rpm-python [(platform:redhat platform:base-py2)] From 967abbd73024824f2d356f7d3e97efc975ebc28c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20R=C5=AF=C5=BEi=C4=8Dka?= Date: Mon, 8 Mar 2021 12:20:08 +0100 Subject: [PATCH 03/56] Allow disabling callback plugin even if it gets loaded (#1161) Foreman_ansible decides whether the callback should be used to prevent facts from being uploaded in case ansible is used "just" as a remote execution provider. It was implemented by setting ANSIBLE_CALLBACK_WHITELIST environment variable, but that stomps over any user-configured callback plugins[2]. When we moved to ansible-runner the whitelist env trick was dropped, but also led to facts being uploaded even if we don't want them[1]. While we could read the configured callback plugins from ansible's configuration and change it on the fly, it would be a bit fragile. The configuration can be in different places and noone guarantees that the location or its contents won't change in the foreseeable future. This change allows us to selectively disable the callback plugin if we need to, without any undesired side-effects. [1] - https://projects.theforeman.org/issues/32020 [2] - https://projects.theforeman.org/issues/30373 --- plugins/callback/foreman.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/plugins/callback/foreman.py b/plugins/callback/foreman.py index f34e71a1..6a44c2eb 100644 --- a/plugins/callback/foreman.py +++ b/plugins/callback/foreman.py @@ -66,6 +66,13 @@ ini: - section: callback_foreman key: verify_certs + disable_callback: + description: + - Toggle to make the callback plugin disable itself even if it is loaded. + - It can be set to '1' to prevent the plugin from being used even if it gets loaded. + env: + - name: FOREMAN_CALLBACK_DISABLE + default: 0 ''' import os @@ -105,6 +112,9 @@ def set_options(self, task_keys=None, var_options=None, direct=None): super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct) + if self.get_option('disable_callback'): + self._disable_plugin('Callback disabled by environment.') + self.FOREMAN_URL = self.get_option('url') self.FOREMAN_SSL_CERT = (self.get_option('client_cert'), self.get_option('client_key')) self.FOREMAN_SSL_VERIFY = str(self.get_option('verify_certs')) From d0050d1386f93b2427b4c2b26a0eedb7a35eed08 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Wed, 24 Feb 2021 15:34:24 +0100 Subject: [PATCH 04/56] lookup storage domains and pods --- .../fragments/bz1885234-storage-lookup.yml | 2 ++ plugins/module_utils/foreman_helper.py | 30 +++++++++++++++++++ plugins/modules/compute_profile.py | 14 +++++++-- plugins/modules/host.py | 19 ++++++++---- 4 files changed, 58 insertions(+), 7 deletions(-) create mode 100644 changelogs/fragments/bz1885234-storage-lookup.yml diff --git a/changelogs/fragments/bz1885234-storage-lookup.yml b/changelogs/fragments/bz1885234-storage-lookup.yml new file mode 100644 index 00000000..293373e0 --- /dev/null +++ b/changelogs/fragments/bz1885234-storage-lookup.yml @@ -0,0 +1,2 @@ +minor_changes: + - host, compute_profile - look up the correct id for storage pods and domains given as part of ``volumes_attributes`` (https://bugzilla.redhat.com/show_bug.cgi?id=1885234) diff --git a/plugins/module_utils/foreman_helper.py b/plugins/module_utils/foreman_helper.py index 360f871d..f6563ad7 100644 --- a/plugins/module_utils/foreman_helper.py +++ b/plugins/module_utils/foreman_helper.py @@ -820,6 +820,36 @@ def find_network(self, name, compute_resource, cluster=None): self.fail_json(msg=err_msg) return network + def find_storage_domain(self, name, compute_resource, cluster=None): + if compute_resource['provider'].lower() not in ['ovirt', 'vmware']: + return {'id': name, 'name': name} + + avsd_params = {'id': compute_resource['id']} + if cluster is not None: + avsd_params['cluster_id'] = cluster['_api_identifier'] + available_storage_domains = self.resource_action('compute_resources', 'available_storage_domains', params=avsd_params, + ignore_check_mode=True, record_change=False)['results'] + storage_domain = next((domain for domain in available_storage_domains if domain['name'] == name or domain['id'] == name), None) + if storage_domain is None: + err_msg = "Could not find storage domain '{0}' on compute resource '{1}'.".format(name, compute_resource.get('name')) + self.fail_json(msg=err_msg) + return storage_domain + + def find_storage_pod(self, name, compute_resource, cluster=None): + if compute_resource['provider'].lower() not in ['vmware']: + return {'id': name, 'name': name} + + avsp_params = {'id': compute_resource['id']} + if cluster is not None: + avsp_params['cluster_id'] = cluster['_api_identifier'] + available_storage_pods = self.resource_action('compute_resources', 'available_storage_pods', params=avsp_params, + ignore_check_mode=True, record_change=False)['results'] + storage_pod = next((pod for pod in available_storage_pods if pod['name'] == name or pod['id'] == name), None) + if storage_pod is None: + err_msg = "Could not find storage pod '{0}' on compute resource '{1}'.".format(name, compute_resource.get('name')) + self.fail_json(msg=err_msg) + return storage_pod + def scope_for(self, key, scoped_resource=None): # workaround for https://projects.theforeman.org/issues/31714 if scoped_resource in ['content_views', 'repositories'] and key == 'lifecycle_environment': diff --git a/plugins/modules/compute_profile.py b/plugins/modules/compute_profile.py index c6a2b4c9..dc2f3667 100644 --- a/plugins/modules/compute_profile.py +++ b/plugins/modules/compute_profile.py @@ -195,18 +195,28 @@ def main(): for ca_module_params in compute_attributes: ca_module_params['compute_resource'] = module.find_resource_by_name( 'compute_resources', name=ca_module_params['compute_resource'], failsafe=False, thin=False) + compute_resource = ca_module_params['compute_resource'] if 'vm_attrs' in ca_module_params: if 'cluster' in ca_module_params['vm_attrs']: - cluster = module.find_cluster(ca_module_params['vm_attrs']['cluster'], ca_module_params['compute_resource']) + cluster = module.find_cluster(ca_module_params['vm_attrs']['cluster'], compute_resource) ca_module_params['vm_attrs']['cluster'] = cluster['_api_identifier'] else: cluster = None + if 'volumes_attributes' in ca_module_params['vm_attrs']: + for volume in ca_module_params['vm_attrs']['volumes_attributes'].values(): + if 'storage_pod' in volume: + storage_pod = module.find_storage_pod(volume['storage_pod'], compute_resource, cluster) + volume['storage_pod'] = storage_pod['id'] + if 'storage_domain' in volume: + storage_domain = module.find_storage_domain(volume['storage_domain'], compute_resource, cluster) + volume['storage_domain'] = storage_domain['id'] + if 'interfaces_attributes' in ca_module_params['vm_attrs']: for interface in ca_module_params['vm_attrs']['interfaces_attributes'].values(): if 'network' in interface: - network = module.find_network(interface['network'], ca_module_params['compute_resource'], cluster) + network = module.find_network(interface['network'], compute_resource, cluster) interface['network'] = network['id'] ca_entities = ca_module_params['compute_resource'].get('compute_attributes', []) diff --git a/plugins/modules/host.py b/plugins/modules/host.py index e098904b..c4d14de0 100644 --- a/plugins/modules/host.py +++ b/plugins/modules/host.py @@ -485,11 +485,20 @@ def main(): if 'compute_resource' in module.foreman_params: compute_resource = module.foreman_params['compute_resource'] - if 'compute_attributes' in module.foreman_params and 'cluster' in module.foreman_params['compute_attributes']: - cluster = module.find_cluster(module.foreman_params['compute_attributes']['cluster'], compute_resource) - module.foreman_params['compute_attributes']['cluster'] = cluster['_api_identifier'] - else: - cluster = None + cluster = None + if 'compute_attributes' in module.foreman_params: + if 'cluster' in module.foreman_params['compute_attributes']: + cluster = module.find_cluster(module.foreman_params['compute_attributes']['cluster'], compute_resource) + module.foreman_params['compute_attributes']['cluster'] = cluster['_api_identifier'] + + if 'volumes_attributes' in module.foreman_params['compute_attributes']: + for volume in module.foreman_params['compute_attributes']['volumes_attributes'].values(): + if 'storage_pod' in volume: + storage_pod = module.find_storage_pod(volume['storage_pod'], compute_resource, cluster) + volume['storage_pod'] = storage_pod['id'] + if 'storage_domain' in volume: + storage_domain = module.find_storage_domain(volume['storage_domain'], compute_resource, cluster) + volume['storage_domain'] = storage_domain['id'] if 'interfaces_attributes' in module.foreman_params: for interface in module.foreman_params['interfaces_attributes']: From 3789bb803743f39b7ab007ae8ca7af51ba890575 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Thu, 25 Feb 2021 11:12:06 +0100 Subject: [PATCH 05/56] re-record compute profile fixtures --- .../fixtures/compute_profile_ovirt-0.yml | 96 ++++++++++++---- .../fixtures/compute_profile_ovirt-1.yml | 106 +++++++++++++----- .../fixtures/compute_profile_ovirt-2.yml | 14 +-- .../fixtures/compute_profile_ovirt-3.yml | 2 +- tests/test_playbooks/vars/compute_profile.yml | 2 +- 5 files changed, 167 insertions(+), 53 deletions(-) diff --git a/tests/test_playbooks/fixtures/compute_profile_ovirt-0.yml b/tests/test_playbooks/fixtures/compute_profile_ovirt-0.yml index d8916585..84184726 100644 --- a/tests/test_playbooks/fixtures/compute_profile_ovirt-0.yml +++ b/tests/test_playbooks/fixtures/compute_profile_ovirt-0.yml @@ -70,7 +70,7 @@ interactions: uri: https://foreman.example.org/api/compute_profiles?search=name%3D%22Test+Compute+Profile%22&per_page=4294967296 response: body: - string: "{\n \"total\": 4,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\"\ + string: "{\n \"total\": 3,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\"\ : 4294967296,\n \"search\": \"name=\\\"Test Compute Profile\\\"\",\n \"\ sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": []\n\ }\n" @@ -133,8 +133,8 @@ interactions: uri: https://foreman.example.org/api/compute_profiles response: body: - string: '{"created_at":"2021-02-17 14:12:20 UTC","updated_at":"2021-02-17 14:12:20 - UTC","id":10,"name":"Test Compute Profile","compute_attributes":[]}' + string: '{"created_at":"2021-02-25 09:03:59 UTC","updated_at":"2021-02-25 09:03:59 + UTC","id":5,"name":"Test Compute Profile","compute_attributes":[]}' headers: Cache-Control: - max-age=0, private, must-revalidate @@ -188,12 +188,12 @@ interactions: uri: https://foreman.example.org/api/compute_resources?search=name%3D%22ovirt-cr01%22&per_page=4294967296 response: body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ : 4294967296,\n \"search\": \"name=\\\"ovirt-cr01\\\"\",\n \"sort\": {\n\ \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"description\"\ :\"\",\"url\":\"https://ovirt.example.com/ovirt-engine/api\"\ - ,\"created_at\":\"2021-02-17 13:47:22 UTC\",\"updated_at\":\"2021-02-17 13:47:22\ - \ UTC\",\"id\":3,\"name\":\"ovirt-cr01\",\"provider\":\"Ovirt\",\"provider_friendly_name\"\ + ,\"created_at\":\"2021-02-25 09:01:13 UTC\",\"updated_at\":\"2021-02-25 09:01:13\ + \ UTC\",\"id\":1,\"name\":\"ovirt-cr01\",\"provider\":\"Ovirt\",\"provider_friendly_name\"\ :\"oVirt\",\"user\":\"admin@internal\",\"datacenter\":\"1b59bc75-99ab-4ee8-b9e0-d59b4a0c59df\"\ ,\"ovirt_quota\":\"489f068e-7d27-445d-853d-c0247e878871\",\"display_type\"\ :\"vnc\",\"keyboard_layout\":\"en-us\"}]\n}\n" @@ -249,13 +249,12 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/api/compute_resources/3 + uri: https://foreman.example.org/api/compute_resources/1 response: body: - string: '{"description":"","url":"https://ovirt.example.com/ovirt-engine/api","created_at":"2021-02-17 - 13:47:22 UTC","updated_at":"2021-02-17 13:47:22 UTC","id":3,"name":"ovirt-cr01","provider":"Ovirt","provider_friendly_name":"oVirt","user":"admin@internal","datacenter":"1b59bc75-99ab-4ee8-b9e0-d59b4a0c59df","ovirt_quota":"489f068e-7d27-445d-853d-c0247e878871","display_type":"vnc","keyboard_layout":"en-us","images":[],"compute_attributes":[{"id":2,"name":"1 - Cores and 1 GB memory","compute_resource_id":3,"compute_resource_name":"ovirt-cr01","provider_friendly_name":"oVirt","compute_profile_id":4,"compute_profile_name":"lol","vm_attrs":{"cluster":"7363a2e5-20a9-458a-a212-7c0bae19331a","template":"","instance_type":"","cores":"1","sockets":"1","memory":"1073741824","ha":"0","display":{"type":"vnc","keyboard_layout":"en-us"},"volumes_attributes":{"1613570707652":{"size_gb":"","storage_domain":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","id":"","preallocate":"0","wipe_after_delete":"0","interface":"virtio_scsi"}}},"attributes":{"cores":"1","interfaces_attributes":{},"memory":"1073741824","cluster_id":"7363a2e5-20a9-458a-a212-7c0bae19331a","cluster_name":"Devel-Infra","template_id":"","template_name":null,"volumes_attributes":{"1613570707652":{"size":"0","storage_domain_id":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","storage_domain_name":"Local-IBM","preallocate":false,"bootable":null}}}}],"locations":[{"id":6,"name":"Test - Location","title":"Test Location","description":null}],"organizations":[{"id":5,"name":"Test + string: '{"description":"","url":"https://ovirt.example.com/ovirt-engine/api","created_at":"2021-02-25 + 09:01:13 UTC","updated_at":"2021-02-25 09:01:13 UTC","id":1,"name":"ovirt-cr01","provider":"Ovirt","provider_friendly_name":"oVirt","user":"admin@internal","datacenter":"1b59bc75-99ab-4ee8-b9e0-d59b4a0c59df","ovirt_quota":"489f068e-7d27-445d-853d-c0247e878871","display_type":"vnc","keyboard_layout":"en-us","images":[],"compute_attributes":[],"locations":[{"id":2,"name":"Default + Location","title":"Default Location","description":null}],"organizations":[{"id":3,"name":"Test Organization","title":"Test Organization","description":"A test organization"}]}' headers: Cache-Control: @@ -293,7 +292,7 @@ interactions: X-XSS-Protection: - 1; mode=block content-length: - - '1624' + - '674' status: code: 200 message: OK @@ -309,7 +308,7 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/api/compute_resources/3/available_clusters + uri: https://foreman.example.org/api/compute_resources/1/available_clusters response: body: string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ @@ -368,7 +367,66 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/api/compute_resources/3/available_clusters/7363a2e5-20a9-458a-a212-7c0bae19331a/available_networks + uri: https://foreman.example.org/api/compute_resources/1/available_clusters/7363a2e5-20a9-458a-a212-7c0bae19331a/available_storage_domains + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 20,\n \"search\": null,\n \"sort\": {\n \"by\": null,\n \"order\"\ + : null\n },\n \"results\": [{\"name\":\"Local-IBM\",\"id\":\"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0\"\ + }]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=94 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '215' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/compute_resources/1/available_clusters/7363a2e5-20a9-458a-a212-7c0bae19331a/available_networks response: body: string: "{\n \"total\": 3,\n \"subtotal\": 3,\n \"page\": 1,\n \"per_page\"\ @@ -397,7 +455,7 @@ interactions: Foreman_version: - 2.5.0-develop Keep-Alive: - - timeout=15, max=94 + - timeout=15, max=93 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -438,11 +496,11 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://foreman.example.org/api/compute_profiles/10/compute_resources/3/compute_attributes + uri: https://foreman.example.org/api/compute_profiles/5/compute_resources/1/compute_attributes response: body: - string: '{"created_at":"2021-02-17 14:12:26 UTC","updated_at":"2021-02-17 14:12:26 - UTC","id":4,"name":"2 Cores and 1 GB memory","compute_resource_id":3,"compute_resource_name":"ovirt-cr01","provider_friendly_name":"oVirt","compute_profile_id":10,"compute_profile_name":"Test + string: '{"created_at":"2021-02-25 09:04:05 UTC","updated_at":"2021-02-25 09:04:05 + UTC","id":1,"name":"2 Cores and 1 GB memory","compute_resource_id":1,"compute_resource_name":"ovirt-cr01","provider_friendly_name":"oVirt","compute_profile_id":5,"compute_profile_name":"Test Compute Profile","vm_attrs":{"cluster":"7363a2e5-20a9-458a-a212-7c0bae19331a","cores":2,"sockets":1,"memory":1073741824,"ha":0,"interfaces_attributes":{"0":{"name":"","network":"b52ae3b6-7c03-470c-ace8-a27ad3fe9a93","interface":"virtio"}},"volumes_attributes":{"0":{"size_gb":"16","storage_domain":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","preallocate":"1","wipe_after_delete":"0","interface":"virtio_scsi","bootable":"true"}}},"attributes":{"cores":2,"interfaces_attributes":{"0":{"name":"","network_id":"b52ae3b6-7c03-470c-ace8-a27ad3fe9a93","network_name":"ovirtmgmt"}},"memory":1073741824,"cluster_id":"7363a2e5-20a9-458a-a212-7c0bae19331a","cluster_name":"Devel-Infra","template_id":null,"template_name":null,"volumes_attributes":{"0":{"size":"17179869184","storage_domain_id":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","storage_domain_name":"Local-IBM","preallocate":true,"bootable":true}}}}' headers: Cache-Control: @@ -464,7 +522,7 @@ interactions: Foreman_version: - 2.5.0-develop Keep-Alive: - - timeout=15, max=93 + - timeout=15, max=92 Strict-Transport-Security: - max-age=631139040; includeSubdomains Transfer-Encoding: diff --git a/tests/test_playbooks/fixtures/compute_profile_ovirt-1.yml b/tests/test_playbooks/fixtures/compute_profile_ovirt-1.yml index 698fe14d..aaa24a48 100644 --- a/tests/test_playbooks/fixtures/compute_profile_ovirt-1.yml +++ b/tests/test_playbooks/fixtures/compute_profile_ovirt-1.yml @@ -70,11 +70,11 @@ interactions: uri: https://foreman.example.org/api/compute_profiles?search=name%3D%22Test+Compute+Profile%22&per_page=4294967296 response: body: - string: "{\n \"total\": 5,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ : 4294967296,\n \"search\": \"name=\\\"Test Compute Profile\\\"\",\n \"\ sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"\ - created_at\":\"2021-02-17 14:12:20 UTC\",\"updated_at\":\"2021-02-17 14:12:20\ - \ UTC\",\"id\":10,\"name\":\"Test Compute Profile\"}]\n}\n" + created_at\":\"2021-02-25 09:03:59 UTC\",\"updated_at\":\"2021-02-25 09:03:59\ + \ UTC\",\"id\":5,\"name\":\"Test Compute Profile\"}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -111,7 +111,7 @@ interactions: X-XSS-Protection: - 1; mode=block content-length: - - '303' + - '302' status: code: 200 message: OK @@ -127,12 +127,12 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/api/compute_profiles/10 + uri: https://foreman.example.org/api/compute_profiles/5 response: body: - string: '{"created_at":"2021-02-17 14:12:20 UTC","updated_at":"2021-02-17 14:12:20 - UTC","id":10,"name":"Test Compute Profile","compute_attributes":[{"id":4,"name":"2 - Cores and 1 GB memory","compute_resource_id":3,"compute_resource_name":"ovirt-cr01","provider_friendly_name":"oVirt","compute_profile_id":10,"compute_profile_name":"Test + string: '{"created_at":"2021-02-25 09:03:59 UTC","updated_at":"2021-02-25 09:03:59 + UTC","id":5,"name":"Test Compute Profile","compute_attributes":[{"id":1,"name":"2 + Cores and 1 GB memory","compute_resource_id":1,"compute_resource_name":"ovirt-cr01","provider_friendly_name":"oVirt","compute_profile_id":5,"compute_profile_name":"Test Compute Profile","vm_attrs":{"cluster":"7363a2e5-20a9-458a-a212-7c0bae19331a","cores":2,"sockets":1,"memory":1073741824,"ha":0,"interfaces_attributes":{"0":{"name":"","network":"b52ae3b6-7c03-470c-ace8-a27ad3fe9a93","interface":"virtio"}},"volumes_attributes":{"0":{"size_gb":"16","storage_domain":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","preallocate":"1","wipe_after_delete":"0","interface":"virtio_scsi","bootable":"true"}}},"attributes":{"cores":2,"interfaces_attributes":{"0":{"name":"","network_id":"b52ae3b6-7c03-470c-ace8-a27ad3fe9a93","network_name":"ovirtmgmt"}},"memory":1073741824,"cluster_id":"7363a2e5-20a9-458a-a212-7c0bae19331a","cluster_name":"Devel-Infra","template_id":null,"template_name":null,"volumes_attributes":{"0":{"size":"17179869184","storage_domain_id":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","storage_domain_name":"Local-IBM","preallocate":true,"bootable":true}}}}]}' headers: Cache-Control: @@ -157,8 +157,6 @@ interactions: - timeout=15, max=98 Strict-Transport-Security: - max-age=631139040; includeSubdomains - Transfer-Encoding: - - chunked Vary: - Accept-Encoding X-Content-Type-Options: @@ -172,7 +170,7 @@ interactions: X-XSS-Protection: - 1; mode=block content-length: - - '1224' + - '1222' status: code: 200 message: OK @@ -191,12 +189,12 @@ interactions: uri: https://foreman.example.org/api/compute_resources?search=name%3D%22ovirt-cr01%22&per_page=4294967296 response: body: - string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ : 4294967296,\n \"search\": \"name=\\\"ovirt-cr01\\\"\",\n \"sort\": {\n\ \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"description\"\ :\"\",\"url\":\"https://ovirt.example.com/ovirt-engine/api\"\ - ,\"created_at\":\"2021-02-17 13:47:22 UTC\",\"updated_at\":\"2021-02-17 13:47:22\ - \ UTC\",\"id\":3,\"name\":\"ovirt-cr01\",\"provider\":\"Ovirt\",\"provider_friendly_name\"\ + ,\"created_at\":\"2021-02-25 09:01:13 UTC\",\"updated_at\":\"2021-02-25 09:01:13\ + \ UTC\",\"id\":1,\"name\":\"ovirt-cr01\",\"provider\":\"Ovirt\",\"provider_friendly_name\"\ :\"oVirt\",\"user\":\"admin@internal\",\"datacenter\":\"1b59bc75-99ab-4ee8-b9e0-d59b4a0c59df\"\ ,\"ovirt_quota\":\"489f068e-7d27-445d-853d-c0247e878871\",\"display_type\"\ :\"vnc\",\"keyboard_layout\":\"en-us\"}]\n}\n" @@ -252,15 +250,14 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/api/compute_resources/3 + uri: https://foreman.example.org/api/compute_resources/1 response: body: - string: '{"description":"","url":"https://ovirt.example.com/ovirt-engine/api","created_at":"2021-02-17 - 13:47:22 UTC","updated_at":"2021-02-17 13:47:22 UTC","id":3,"name":"ovirt-cr01","provider":"Ovirt","provider_friendly_name":"oVirt","user":"admin@internal","datacenter":"1b59bc75-99ab-4ee8-b9e0-d59b4a0c59df","ovirt_quota":"489f068e-7d27-445d-853d-c0247e878871","display_type":"vnc","keyboard_layout":"en-us","images":[],"compute_attributes":[{"id":2,"name":"1 - Cores and 1 GB memory","compute_resource_id":3,"compute_resource_name":"ovirt-cr01","provider_friendly_name":"oVirt","compute_profile_id":4,"compute_profile_name":"lol","vm_attrs":{"cluster":"7363a2e5-20a9-458a-a212-7c0bae19331a","template":"","instance_type":"","cores":"1","sockets":"1","memory":"1073741824","ha":"0","display":{"type":"vnc","keyboard_layout":"en-us"},"volumes_attributes":{"1613570707652":{"size_gb":"","storage_domain":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","id":"","preallocate":"0","wipe_after_delete":"0","interface":"virtio_scsi"}}},"attributes":{"cores":"1","interfaces_attributes":{},"memory":"1073741824","cluster_id":"7363a2e5-20a9-458a-a212-7c0bae19331a","cluster_name":"Devel-Infra","template_id":"","template_name":null,"volumes_attributes":{"1613570707652":{"size":"0","storage_domain_id":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","storage_domain_name":"Local-IBM","preallocate":false,"bootable":null}}}},{"id":4,"name":"2 - Cores and 1 GB memory","compute_resource_id":3,"compute_resource_name":"ovirt-cr01","provider_friendly_name":"oVirt","compute_profile_id":10,"compute_profile_name":"Test - Compute Profile","vm_attrs":{"cluster":"7363a2e5-20a9-458a-a212-7c0bae19331a","cores":2,"sockets":1,"memory":1073741824,"ha":0,"interfaces_attributes":{"0":{"name":"","network":"b52ae3b6-7c03-470c-ace8-a27ad3fe9a93","interface":"virtio"}},"volumes_attributes":{"0":{"size_gb":"16","storage_domain":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","preallocate":"1","wipe_after_delete":"0","interface":"virtio_scsi","bootable":"true"}}},"attributes":{"cores":2,"interfaces_attributes":{"0":{"name":"","network_id":"b52ae3b6-7c03-470c-ace8-a27ad3fe9a93","network_name":"ovirtmgmt"}},"memory":1073741824,"cluster_id":"7363a2e5-20a9-458a-a212-7c0bae19331a","cluster_name":"Devel-Infra","template_id":null,"template_name":null,"volumes_attributes":{"0":{"size":"17179869184","storage_domain_id":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","storage_domain_name":"Local-IBM","preallocate":true,"bootable":true}}}}],"locations":[{"id":6,"name":"Test - Location","title":"Test Location","description":null}],"organizations":[{"id":5,"name":"Test + string: '{"description":"","url":"https://ovirt.example.com/ovirt-engine/api","created_at":"2021-02-25 + 09:01:13 UTC","updated_at":"2021-02-25 09:01:13 UTC","id":1,"name":"ovirt-cr01","provider":"Ovirt","provider_friendly_name":"oVirt","user":"admin@internal","datacenter":"1b59bc75-99ab-4ee8-b9e0-d59b4a0c59df","ovirt_quota":"489f068e-7d27-445d-853d-c0247e878871","display_type":"vnc","keyboard_layout":"en-us","images":[],"compute_attributes":[{"id":1,"name":"2 + Cores and 1 GB memory","compute_resource_id":1,"compute_resource_name":"ovirt-cr01","provider_friendly_name":"oVirt","compute_profile_id":5,"compute_profile_name":"Test + Compute Profile","vm_attrs":{"cluster":"7363a2e5-20a9-458a-a212-7c0bae19331a","cores":2,"sockets":1,"memory":1073741824,"ha":0,"interfaces_attributes":{"0":{"name":"","network":"b52ae3b6-7c03-470c-ace8-a27ad3fe9a93","interface":"virtio"}},"volumes_attributes":{"0":{"size_gb":"16","storage_domain":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","preallocate":"1","wipe_after_delete":"0","interface":"virtio_scsi","bootable":"true"}}},"attributes":{"cores":2,"interfaces_attributes":{"0":{"name":"","network_id":"b52ae3b6-7c03-470c-ace8-a27ad3fe9a93","network_name":"ovirtmgmt"}},"memory":1073741824,"cluster_id":"7363a2e5-20a9-458a-a212-7c0bae19331a","cluster_name":"Devel-Infra","template_id":null,"template_name":null,"volumes_attributes":{"0":{"size":"17179869184","storage_domain_id":"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0","storage_domain_name":"Local-IBM","preallocate":true,"bootable":true}}}}],"locations":[{"id":2,"name":"Default + Location","title":"Default Location","description":null}],"organizations":[{"id":3,"name":"Test Organization","title":"Test Organization","description":"A test organization"}]}' headers: Cache-Control: @@ -298,7 +295,7 @@ interactions: X-XSS-Protection: - 1; mode=block content-length: - - '2708' + - '1756' status: code: 200 message: OK @@ -314,7 +311,7 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/api/compute_resources/3/available_clusters + uri: https://foreman.example.org/api/compute_resources/1/available_clusters response: body: string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ @@ -373,7 +370,66 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://foreman.example.org/api/compute_resources/3/available_clusters/7363a2e5-20a9-458a-a212-7c0bae19331a/available_networks + uri: https://foreman.example.org/api/compute_resources/1/available_clusters/7363a2e5-20a9-458a-a212-7c0bae19331a/available_storage_domains + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 20,\n \"search\": null,\n \"sort\": {\n \"by\": null,\n \"order\"\ + : null\n },\n \"results\": [{\"name\":\"Local-IBM\",\"id\":\"d82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0\"\ + }]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=94 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '215' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/compute_resources/1/available_clusters/7363a2e5-20a9-458a-a212-7c0bae19331a/available_networks response: body: string: "{\n \"total\": 3,\n \"subtotal\": 3,\n \"page\": 1,\n \"per_page\"\ @@ -402,7 +458,7 @@ interactions: Foreman_version: - 2.5.0-develop Keep-Alive: - - timeout=15, max=94 + - timeout=15, max=93 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: diff --git a/tests/test_playbooks/fixtures/compute_profile_ovirt-2.yml b/tests/test_playbooks/fixtures/compute_profile_ovirt-2.yml index 95bf1764..a921ef40 100644 --- a/tests/test_playbooks/fixtures/compute_profile_ovirt-2.yml +++ b/tests/test_playbooks/fixtures/compute_profile_ovirt-2.yml @@ -70,11 +70,11 @@ interactions: uri: https://foreman.example.org/api/compute_profiles?search=name%3D%22Test+Compute+Profile%22&per_page=4294967296 response: body: - string: "{\n \"total\": 5,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ : 4294967296,\n \"search\": \"name=\\\"Test Compute Profile\\\"\",\n \"\ sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"\ - created_at\":\"2021-02-17 14:12:20 UTC\",\"updated_at\":\"2021-02-17 14:12:20\ - \ UTC\",\"id\":10,\"name\":\"Test Compute Profile\"}]\n}\n" + created_at\":\"2021-02-25 09:03:59 UTC\",\"updated_at\":\"2021-02-25 09:03:59\ + \ UTC\",\"id\":5,\"name\":\"Test Compute Profile\"}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -111,7 +111,7 @@ interactions: X-XSS-Protection: - 1; mode=block content-length: - - '303' + - '302' status: code: 200 message: OK @@ -129,10 +129,10 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: DELETE - uri: https://foreman.example.org/api/compute_profiles/10 + uri: https://foreman.example.org/api/compute_profiles/5 response: body: - string: '{"id":10,"name":"Test Compute Profile","created_at":"2021-02-17T14:12:20.366Z","updated_at":"2021-02-17T14:12:20.366Z"}' + string: '{"id":5,"name":"Test Compute Profile","created_at":"2021-02-25T09:03:59.889Z","updated_at":"2021-02-25T09:03:59.889Z"}' headers: Cache-Control: - max-age=0, private, must-revalidate @@ -169,7 +169,7 @@ interactions: X-XSS-Protection: - 1; mode=block content-length: - - '119' + - '118' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/compute_profile_ovirt-3.yml b/tests/test_playbooks/fixtures/compute_profile_ovirt-3.yml index cacf990b..85ed04e5 100644 --- a/tests/test_playbooks/fixtures/compute_profile_ovirt-3.yml +++ b/tests/test_playbooks/fixtures/compute_profile_ovirt-3.yml @@ -70,7 +70,7 @@ interactions: uri: https://foreman.example.org/api/compute_profiles?search=name%3D%22Test+Compute+Profile%22&per_page=4294967296 response: body: - string: "{\n \"total\": 4,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\"\ + string: "{\n \"total\": 3,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\"\ : 4294967296,\n \"search\": \"name=\\\"Test Compute Profile\\\"\",\n \"\ sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": []\n\ }\n" diff --git a/tests/test_playbooks/vars/compute_profile.yml b/tests/test_playbooks/vars/compute_profile.yml index fbc16757..2c4f9f47 100644 --- a/tests/test_playbooks/vars/compute_profile.yml +++ b/tests/test_playbooks/vars/compute_profile.yml @@ -54,7 +54,7 @@ ovirt: volumes_attributes: 0: size_gb: '16' - storage_domain: 'd82a0993-5fb7-4ef4-8abf-fd2ccf0e87f0' + storage_domain: 'Local-IBM' preallocate: '1' wipe_after_delete: '0' interface: 'virtio_scsi' From 5bab40bf310023280c2eaa0a8532389bc94df525 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Fri, 5 Mar 2021 15:15:37 +0100 Subject: [PATCH 06/56] add subnet_info module --- plugins/modules/subnet_info.py | 81 ++++++++ tests/fixtures/apidoc/subnet_info.json | 1 + .../test_playbooks/fixtures/subnet_info-0.yml | 185 ++++++++++++++++++ .../test_playbooks/fixtures/subnet_info-1.yml | 127 ++++++++++++ tests/test_playbooks/subnet_info.yml | 99 ++++++++++ 5 files changed, 493 insertions(+) create mode 100644 plugins/modules/subnet_info.py create mode 120000 tests/fixtures/apidoc/subnet_info.json create mode 100644 tests/test_playbooks/fixtures/subnet_info-0.yml create mode 100644 tests/test_playbooks/fixtures/subnet_info-1.yml create mode 100644 tests/test_playbooks/subnet_info.yml diff --git a/plugins/modules/subnet_info.py b/plugins/modules/subnet_info.py new file mode 100644 index 00000000..911a1eb1 --- /dev/null +++ b/plugins/modules/subnet_info.py @@ -0,0 +1,81 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# (c) 2021 Evgeni Golov +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +DOCUMENTATION = ''' +--- +module: subnet_info +version_added: 2.1.0 +short_description: Fetch information about Subnets +description: + - Fetch information about Subnets +author: + - "Evgeni Golov (@evgeni)" +extends_documentation_fragment: + - theforeman.foreman.foreman + - theforeman.foreman.foreman.infomodule +''' + +EXAMPLES = ''' +- name: "Show a subnet" + theforeman.foreman.subnet_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + name: "subnet.example.com" + +- name: "Show all subnets with domain example.com" + theforeman.foreman.subnet_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + search: "domain = example.com" +''' + +RETURN = ''' +subnet: + description: Details about the found subnet + returned: success and I(name) was passed + type: dict +subnets: + description: List of all found subnets and their details + returned: success and I(search) was passed + type: list + elements: dict +''' + +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( + ForemanInfoAnsibleModule, +) + + +class ForemanSubnetInfo(ForemanInfoAnsibleModule): + pass + + +def main(): + module = ForemanSubnetInfo() + + with module.api_connection(): + module.run() + + +if __name__ == '__main__': + main() diff --git a/tests/fixtures/apidoc/subnet_info.json b/tests/fixtures/apidoc/subnet_info.json new file mode 120000 index 00000000..f9e40151 --- /dev/null +++ b/tests/fixtures/apidoc/subnet_info.json @@ -0,0 +1 @@ +foreman.json \ No newline at end of file diff --git a/tests/test_playbooks/fixtures/subnet_info-0.yml b/tests/test_playbooks/fixtures/subnet_info-0.yml new file mode 100644 index 00000000..d07332e6 --- /dev/null +++ b/tests/test_playbooks/fixtures/subnet_info-0.yml @@ -0,0 +1,185 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/subnets?search=name%3D%22testnet%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"testnet\\\"\",\n \"sort\": {\n \ + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"network\"\ + :\"192.168.200.0\",\"network_type\":\"IPv4\",\"cidr\":24,\"mask\":\"255.255.255.0\"\ + ,\"priority\":null,\"vlanid\":null,\"mtu\":1500,\"gateway\":null,\"dns_primary\"\ + :null,\"dns_secondary\":null,\"from\":null,\"to\":null,\"created_at\":\"2021-03-08\ + \ 14:57:10 UTC\",\"updated_at\":\"2021-03-08 14:57:10 UTC\",\"ipam\":\"DHCP\"\ + ,\"boot_mode\":\"DHCP\",\"nic_delay\":null,\"id\":2,\"name\":\"testnet\",\"\ + description\":null,\"network_address\":\"192.168.200.0/24\",\"dhcp_id\":null,\"\ + dhcp_name\":null,\"tftp_id\":null,\"tftp_name\":null,\"httpboot_id\":null,\"\ + httpboot_name\":null,\"externalipam_id\":null,\"externalipam_name\":null,\"\ + dns_id\":null,\"template_id\":null,\"template_name\":null,\"bmc_id\":null,\"\ + bmc_name\":null,\"dhcp\":null,\"tftp\":null,\"httpboot\":null,\"externalipam\"\ + :null,\"dns\":null,\"template\":null,\"bmc\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '915' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/subnets/2 + response: + body: + string: '{"network":"192.168.200.0","network_type":"IPv4","cidr":24,"mask":"255.255.255.0","priority":null,"vlanid":null,"mtu":1500,"gateway":null,"dns_primary":null,"dns_secondary":null,"from":null,"to":null,"created_at":"2021-03-08 + 14:57:10 UTC","updated_at":"2021-03-08 14:57:10 UTC","ipam":"DHCP","boot_mode":"DHCP","nic_delay":null,"id":2,"name":"testnet","description":null,"network_address":"192.168.200.0/24","dhcp_id":null,"dhcp_name":null,"tftp_id":null,"tftp_name":null,"httpboot_id":null,"httpboot_name":null,"externalipam_id":null,"externalipam_name":null,"dns_id":null,"template_id":null,"template_name":null,"bmc_id":null,"bmc_name":null,"dhcp":null,"tftp":null,"httpboot":null,"externalipam":null,"dns":null,"template":null,"bmc":null,"remote_execution_proxies":[],"domains":[{"id":2,"name":"example.net"}],"interfaces":[],"parameters":[],"locations":[{"id":4,"name":"Test + Location","title":"Test Location","description":null}],"organizations":[]}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '954' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/subnet_info-1.yml b/tests/test_playbooks/fixtures/subnet_info-1.yml new file mode 100644 index 00000000..206d8f0e --- /dev/null +++ b/tests/test_playbooks/fixtures/subnet_info-1.yml @@ -0,0 +1,127 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/subnets?search=name+%3D+testnet&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name = testnet\",\n \"sort\": {\n \"by\"\ + : null,\n \"order\": null\n },\n \"results\": [{\"network\":\"192.168.200.0\"\ + ,\"network_type\":\"IPv4\",\"cidr\":24,\"mask\":\"255.255.255.0\",\"priority\"\ + :null,\"vlanid\":null,\"mtu\":1500,\"gateway\":null,\"dns_primary\":null,\"\ + dns_secondary\":null,\"from\":null,\"to\":null,\"created_at\":\"2021-03-08\ + \ 14:57:10 UTC\",\"updated_at\":\"2021-03-08 14:57:10 UTC\",\"ipam\":\"DHCP\"\ + ,\"boot_mode\":\"DHCP\",\"nic_delay\":null,\"id\":2,\"name\":\"testnet\",\"\ + description\":null,\"network_address\":\"192.168.200.0/24\",\"dhcp_id\":null,\"\ + dhcp_name\":null,\"tftp_id\":null,\"tftp_name\":null,\"httpboot_id\":null,\"\ + httpboot_name\":null,\"externalipam_id\":null,\"externalipam_name\":null,\"\ + dns_id\":null,\"template_id\":null,\"template_name\":null,\"bmc_id\":null,\"\ + bmc_name\":null,\"dhcp\":null,\"tftp\":null,\"httpboot\":null,\"externalipam\"\ + :null,\"dns\":null,\"template\":null,\"bmc\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '913' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/subnet_info.yml b/tests/test_playbooks/subnet_info.yml new file mode 100644 index 00000000..b12be9fc --- /dev/null +++ b/tests/test_playbooks/subnet_info.yml @@ -0,0 +1,99 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include_tasks: tasks/organization.yml + vars: + organization_state: present + - include_tasks: tasks/location.yml + vars: + location_organizations: + - "Test Organization" + location_state: present + - include_tasks: tasks/domain.yml + vars: + domain_name: "example.net" + domain_locations: + - "Test Location" + domain_organizations: + - "Test Organization" + domain_state: present + - name: create subnet + include_tasks: tasks/subnet.yml + vars: + subnet_name: "testnet" + subnet_organization: + - "Test Organization" + subnet_locations: + - "Test Location" + subnet_domains: + - "example.net" + subnet_cidr: 24 + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: fetch subnet info + subnet_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + name: "testnet" + register: subnet_info + - name: check subnet details + assert: + that: + - subnet_info['subnet']['name'] == "testnet" + - subnet_info['subnet']['domains'][0]['name'] == "example.net" + + - name: search subnet info + subnet_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + search: "name = testnet" + register: subnet_info + - name: check subnet details + assert: + that: + - subnet_info['subnets'][0]['name'] == "testnet" + +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: unassign domain from subnet + include_tasks: tasks/subnet.yml + vars: + subnet_name: "testnet" + subnet_cidr: 24 + subnet_domains: [] + - name: delete subnet + include_tasks: tasks/subnet.yml + vars: + subnet_name: "testnet" + subnet_state: absent + - include_tasks: tasks/domain.yml + vars: + domain_name: "example.net" + domain_state: absent + - include_tasks: tasks/location.yml + vars: + location_state: absent + - include_tasks: tasks/organization.yml + vars: + organization_state: absent +... From 390a80d6f676d211be9f8f1e98ff5f286c3b54b3 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Wed, 10 Mar 2021 16:48:15 +0100 Subject: [PATCH 07/56] support Foreman's structured plugin details Foreman 2.4 [1] started to return plugin information in a structured way, let's be nice and support that too :-) [1] https://github.com/theforeman/foreman/pull/8207/ --- plugins/modules/scc_product.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/plugins/modules/scc_product.py b/plugins/modules/scc_product.py index 67867b68..bb39aea5 100644 --- a/plugins/modules/scc_product.py +++ b/plugins/modules/scc_product.py @@ -81,8 +81,12 @@ def main(): statuses = module.foremanapi.resource('ping').call('statuses') plugins = statuses['results']['foreman']['plugins'] for plugin in plugins: - if 'foreman_scc_manager' in plugin: - scc_version = plugin.split(',')[1] + if isinstance(plugin, dict): + if plugin['name'] == 'foreman_scc_manager': + scc_version = plugin['version'] + else: + if 'foreman_scc_manager' in plugin: + scc_version = plugin.split(',')[1] except Exception: pass From a1a0c3c96de8a082d794f1346bc3553f9cfe9da5 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Thu, 11 Mar 2021 11:54:40 +0100 Subject: [PATCH 08/56] dry up search for compute_resource parts --- plugins/module_utils/foreman_helper.py | 66 ++++++++------------------ 1 file changed, 21 insertions(+), 45 deletions(-) diff --git a/plugins/module_utils/foreman_helper.py b/plugins/module_utils/foreman_helper.py index f6563ad7..4bda606d 100644 --- a/plugins/module_utils/foreman_helper.py +++ b/plugins/module_utils/foreman_helper.py @@ -788,67 +788,43 @@ def find_puppetclasses(self, names, **kwargs): return [self.find_puppetclass(name, **kwargs) for name in names] def find_cluster(self, name, compute_resource): - if compute_resource['provider'].lower() not in ['ovirt', 'vmware']: - return {'id': name, 'name': name, '_api_identifier': name} - - avc_params = {'id': compute_resource['id']} - available_clusters = self.resource_action('compute_resources', 'available_clusters', params=avc_params, - ignore_check_mode=True, record_change=False)['results'] - cluster = next((cluster for cluster in available_clusters if cluster['name'] == name or cluster['id'] == name), None) - if cluster is None: - err_msg = "Could not find cluster '{0}' on compute resource '{1}'.".format(name, compute_resource.get('name')) - self.fail_json(msg=err_msg) + cluster = self.find_compute_resource_parts('clusters', name, compute_resource, None, ['ovirt', 'vmware']) + # workaround for https://projects.theforeman.org/issues/31874 if compute_resource['provider'].lower() == 'vmware': cluster['_api_identifier'] = cluster['name'] else: cluster['_api_identifier'] = cluster['id'] + return cluster def find_network(self, name, compute_resource, cluster=None): - if compute_resource['provider'].lower() not in ['ovirt', 'vmware', 'google', 'azurerm']: - return {'id': name, 'name': name} - - avn_params = {'id': compute_resource['id']} - if cluster is not None: - avn_params['cluster_id'] = cluster['_api_identifier'] - available_networks = self.resource_action('compute_resources', 'available_networks', params=avn_params, - ignore_check_mode=True, record_change=False)['results'] - network = next((network for network in available_networks if network['name'] == name or network['id'] == name), None) - if network is None: - err_msg = "Could not find network '{0}' on compute resource '{1}'.".format(name, compute_resource.get('name')) - self.fail_json(msg=err_msg) - return network + return self.find_compute_resource_parts('networks', name, compute_resource, cluster, ['ovirt', 'vmware', 'google', 'azurerm']) def find_storage_domain(self, name, compute_resource, cluster=None): - if compute_resource['provider'].lower() not in ['ovirt', 'vmware']: - return {'id': name, 'name': name} - - avsd_params = {'id': compute_resource['id']} - if cluster is not None: - avsd_params['cluster_id'] = cluster['_api_identifier'] - available_storage_domains = self.resource_action('compute_resources', 'available_storage_domains', params=avsd_params, - ignore_check_mode=True, record_change=False)['results'] - storage_domain = next((domain for domain in available_storage_domains if domain['name'] == name or domain['id'] == name), None) - if storage_domain is None: - err_msg = "Could not find storage domain '{0}' on compute resource '{1}'.".format(name, compute_resource.get('name')) - self.fail_json(msg=err_msg) - return storage_domain + return self.find_compute_resource_parts('storage_domains', name, compute_resource, cluster, ['ovirt', 'vmware']) def find_storage_pod(self, name, compute_resource, cluster=None): - if compute_resource['provider'].lower() not in ['vmware']: + return self.find_compute_resource_parts('storage_pods', name, compute_resource, cluster, ['vmware']) + + def find_compute_resource_parts(self, part_name, name, compute_resource, cluster=None, supported_crs=None): + if supported_crs is None: + supported_crs = [] + + if compute_resource['provider'].lower() not in supported_crs: return {'id': name, 'name': name} - avsp_params = {'id': compute_resource['id']} + additional_params = {'id': compute_resource['id']} if cluster is not None: - avsp_params['cluster_id'] = cluster['_api_identifier'] - available_storage_pods = self.resource_action('compute_resources', 'available_storage_pods', params=avsp_params, - ignore_check_mode=True, record_change=False)['results'] - storage_pod = next((pod for pod in available_storage_pods if pod['name'] == name or pod['id'] == name), None) - if storage_pod is None: - err_msg = "Could not find storage pod '{0}' on compute resource '{1}'.".format(name, compute_resource.get('name')) + additional_params['cluster_id'] = cluster['_api_identifier'] + api_name = 'available_{0}'.format(part_name) + available_parts = self.resource_action('compute_resources', api_name, params=additional_params, + ignore_check_mode=True, record_change=False)['results'] + part = next((part for part in available_parts if part['name'] == name or part['id'] == name), None) + if part is None: + err_msg = "Could not find {0} '{1}' on compute resource '{2}'.".format(part_name, name, compute_resource.get('name')) self.fail_json(msg=err_msg) - return storage_pod + return part def scope_for(self, key, scoped_resource=None): # workaround for https://projects.theforeman.org/issues/31714 From c9418f57a849dbeb546e3f74eda7c65612d137de Mon Sep 17 00:00:00 2001 From: "Eric D. Helms" Date: Wed, 10 Mar 2021 14:27:11 -0500 Subject: [PATCH 09/56] Add a content_view_info module --- plugins/modules/content_view_info.py | 81 ++++++++ tests/fixtures/apidoc/content_view_info.json | 1 + tests/test_playbooks/content_view_info.yml | 93 +++++++++ .../fixtures/content_view_info-0.yml | 183 ++++++++++++++++++ .../fixtures/content_view_info-1.yml | 121 ++++++++++++ 5 files changed, 479 insertions(+) create mode 100644 plugins/modules/content_view_info.py create mode 120000 tests/fixtures/apidoc/content_view_info.json create mode 100644 tests/test_playbooks/content_view_info.yml create mode 100644 tests/test_playbooks/fixtures/content_view_info-0.yml create mode 100644 tests/test_playbooks/fixtures/content_view_info-1.yml diff --git a/plugins/modules/content_view_info.py b/plugins/modules/content_view_info.py new file mode 100644 index 00000000..a6bfc23e --- /dev/null +++ b/plugins/modules/content_view_info.py @@ -0,0 +1,81 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# (c) 2021 Eric Helms +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +DOCUMENTATION = ''' +--- +module: content_view_info +version_added: 2.1.0 +short_description: Fetch information about Content Views +description: + - Fetch information about Content Views +author: + - "Eric Helms (@ehelms)" +extends_documentation_fragment: + - theforeman.foreman.foreman + - theforeman.foreman.foreman.infomodule +''' + +EXAMPLES = ''' +- name: "Show a content_view" + theforeman.foreman.content_view_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + name: "CentOS 8" + +- name: "Show all content_views with name CentOS 8" + theforeman.foreman.content_view_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + search: 'name = "CentOS 8"' +''' + +RETURN = ''' +content_view: + description: Details about the found content_view + returned: success and I(name) was passed + type: dict +content_views: + description: List of all found content_views and their details + returned: success and I(search) was passed + type: list + elements: dict +''' + +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( + ForemanInfoAnsibleModule, +) + + +class KatelloContentViewInfo(ForemanInfoAnsibleModule): + pass + + +def main(): + module = KatelloContentViewInfo() + + with module.api_connection(): + module.run() + + +if __name__ == '__main__': + main() diff --git a/tests/fixtures/apidoc/content_view_info.json b/tests/fixtures/apidoc/content_view_info.json new file mode 120000 index 00000000..8e89899a --- /dev/null +++ b/tests/fixtures/apidoc/content_view_info.json @@ -0,0 +1 @@ +katello.json \ No newline at end of file diff --git a/tests/test_playbooks/content_view_info.yml b/tests/test_playbooks/content_view_info.yml new file mode 100644 index 00000000..d4c80460 --- /dev/null +++ b/tests/test_playbooks/content_view_info.yml @@ -0,0 +1,93 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include: tasks/organization.yml + vars: + organization_state: present + - include: tasks/product.yml + vars: + product_state: present + - include: tasks/repository.yml + vars: + repository_state: present + - include: tasks/product.yml + vars: + product_name: "Test Product 2" + product_state: present + - include: tasks/repository.yml + vars: + product_name: "Test Product 2" + repository_state: present + - include: tasks/content_view.yml + vars: + content_view_name: "Test Composite Content View" + content_view_state: absent + - name: Create content view + include: tasks/content_view.yml + vars: + content_view_state: present + expected_change: true + repositories: + - name: "Test Repository" + product: "Test Product" + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: fetch content_view info + content_view_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + name: "Test Content View" + register: content_view_info + - name: check content_view details + assert: + that: + - content_view_info['content_view']['name'] == "Test Content View" + - content_view_info['content_view']['repositories'][0]['name'] == "Test Repository" + + - name: search content_view info + content_view_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + search: 'name = "Test Content View"' + register: content_view_info + - name: check content_view details + assert: + that: + - content_view_info['content_views'][0]['name'] == "Test Content View" + +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include: tasks/content_view.yml + vars: + content_view_state: absent + - include: tasks/repository.yml + vars: + product_name: "Test Product 2" + repository_state: absent + - include: tasks/product.yml + vars: + product_name: "Test Product 2" + product_state: absent + - include: tasks/organization.yml + vars: + organization_state: absent diff --git a/tests/test_playbooks/fixtures/content_view_info-0.yml b/tests/test_playbooks/fixtures/content_view_info-0.yml new file mode 100644 index 00000000..43065f8d --- /dev/null +++ b/tests/test_playbooks/fixtures/content_view_info-0.yml @@ -0,0 +1,183 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + response: + body: + string: '{"total":4,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[42],"id":12,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":7,"organization":{"name":"Test + Organization","label":"Test_Organization","id":7},"created_at":"2021-03-10 + 19:16:47 UTC","updated_at":"2021-03-10 19:16:47 UTC","environments":[],"repositories":[{"id":42,"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}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1058' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_views/12 + response: + body: + string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[42],"id":12,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":7,"organization":{"name":"Test + Organization","label":"Test_Organization","id":7},"created_at":"2021-03-10 + 19:16:47 UTC","updated_at":"2021-03-10 19:16:47 UTC","environments":[],"repositories":[{"id":42,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true},"duplicate_repositories_to_publish":[],"errors":null} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '980' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_info-1.yml b/tests/test_playbooks/fixtures/content_view_info-1.yml new file mode 100644 index 00000000..0d227165 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_view_info-1.yml @@ -0,0 +1,121 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_views?search=name+%3D+%22Test+Content+View%22&per_page=4294967296 + response: + body: + string: '{"total":4,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name + = \"Test Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[42],"id":12,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":7,"organization":{"name":"Test + Organization","label":"Test_Organization","id":7},"created_at":"2021-03-10 + 19:16:47 UTC","updated_at":"2021-03-10 19:16:47 UTC","environments":[],"repositories":[{"id":42,"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}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1060' + status: + code: 200 + message: OK +version: 1 From c13ed2155a792c95681ec662053c925a9aef2b77 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Fri, 12 Mar 2021 14:42:35 +0100 Subject: [PATCH 10/56] explicitly set key_path to no_log False sanity tests now check that and it matches the general /key/ rule. no_log=False is the explicit declaration of "this is not secret" --- plugins/modules/compute_resource.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/modules/compute_resource.py b/plugins/modules/compute_resource.py index 05f3eca5..8a121622 100644 --- a/plugins/modules/compute_resource.py +++ b/plugins/modules/compute_resource.py @@ -423,7 +423,7 @@ def main(): ovirt_quota=dict(), project=dict(), email=dict(), - key_path=dict(), + key_path=dict(no_log=False), zone=dict(), ssl_verify_peer=dict(type='bool'), set_console_password=dict(type='bool'), From dbd8ab270cac9d69f8b1cd1bd1a03e7ffb078260 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Tue, 16 Mar 2021 14:12:47 +0100 Subject: [PATCH 11/56] set no_log=False to more params that are not secret --- plugins/module_utils/foreman_helper.py | 2 +- plugins/modules/product.py | 4 ++-- plugins/modules/repository.py | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/plugins/module_utils/foreman_helper.py b/plugins/module_utils/foreman_helper.py index 4bda606d..130dcd4d 100644 --- a/plugins/module_utils/foreman_helper.py +++ b/plugins/module_utils/foreman_helper.py @@ -300,7 +300,7 @@ def __init__(self, **kwargs): kickstart_repository=dict(type='entity', scope=['organization'], optional_scope=['lifecycle_environment', 'content_view'], resource_type='repositories'), content_view=dict(type='entity', scope=['organization'], optional_scope=['lifecycle_environment']), - activation_keys=dict(), + activation_keys=dict(no_log=False), ) foreman_spec.update(kwargs.pop('foreman_spec', {})) required_plugins = kwargs.pop('required_plugins', []) + [ diff --git a/plugins/modules/product.py b/plugins/modules/product.py index 61710116..9a99e089 100644 --- a/plugins/modules/product.py +++ b/plugins/modules/product.py @@ -124,10 +124,10 @@ def main(): foreman_spec=dict( name=dict(required=True), label=dict(), - gpg_key=dict(type='entity', resource_type='content_credentials', scope=['organization']), + gpg_key=dict(type='entity', resource_type='content_credentials', scope=['organization'], no_log=False), ssl_ca_cert=dict(type='entity', resource_type='content_credentials', scope=['organization']), ssl_client_cert=dict(type='entity', resource_type='content_credentials', scope=['organization']), - ssl_client_key=dict(type='entity', resource_type='content_credentials', scope=['organization']), + ssl_client_key=dict(type='entity', resource_type='content_credentials', scope=['organization'], no_log=False), sync_plan=dict(type='entity', scope=['organization']), description=dict(), ), diff --git a/plugins/modules/repository.py b/plugins/modules/repository.py index 33b790d3..be5708e5 100644 --- a/plugins/modules/repository.py +++ b/plugins/modules/repository.py @@ -271,10 +271,10 @@ def main(): ignore_global_proxy=dict(type='bool'), http_proxy_policy=dict(choices=['global_default_http_proxy', 'none', 'use_selected_http_proxy']), http_proxy=dict(type='entity'), - gpg_key=dict(type='entity', resource_type='content_credentials', scope=['organization']), + gpg_key=dict(type='entity', resource_type='content_credentials', scope=['organization'], no_log=False), ssl_ca_cert=dict(type='entity', resource_type='content_credentials', scope=['organization']), ssl_client_cert=dict(type='entity', resource_type='content_credentials', scope=['organization']), - ssl_client_key=dict(type='entity', resource_type='content_credentials', scope=['organization']), + ssl_client_key=dict(type='entity', resource_type='content_credentials', scope=['organization'], no_log=False), download_policy=dict(choices=['background', 'immediate', 'on_demand']), mirror_on_sync=dict(type='bool', default=True), verify_ssl_on_sync=dict(type='bool'), From 213588ef69a05bf8b598e99914ea7bf23750aea3 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Fri, 19 Mar 2021 07:57:22 +0100 Subject: [PATCH 12/56] update codeql pipeline the head^2 checkout is not needed anymore --- .github/workflows/codeql-analysis.yml | 9 --------- 1 file changed, 9 deletions(-) diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 861595e8..98e5a886 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -23,15 +23,6 @@ jobs: steps: - name: Checkout repository uses: actions/checkout@v2 - with: - # We must fetch at least the immediate parents so that if this is - # a pull request then we can checkout the head. - fetch-depth: 2 - - # If this run was triggered by a pull request event, then checkout - # the head of the pull request instead of the merge commit. - - run: git checkout HEAD^2 - if: ${{ github.event_name == 'pull_request' }} - name: Initialize CodeQL uses: github/codeql-action/init@v1 From 541d1924bc204e82cf0d06e0fbd0d2b69f487738 Mon Sep 17 00:00:00 2001 From: Matthias Dellweg <2500@gmx.de> Date: Tue, 16 Mar 2021 12:58:43 +0100 Subject: [PATCH 13/56] Add ansible roles parameter to hostgroup module fixes #1123 Co-authored-by: Evgeni Golov --- .../1123-ansible-roles-for-hostgroups.yml | 2 + plugins/module_utils/foreman_helper.py | 1 + plugins/modules/hostgroup.py | 27 + .../fixtures/luna_hostgroup-0.yml | 382 +++++------- .../fixtures/luna_hostgroup-1.yml | 407 ++++++------ .../fixtures/luna_hostgroup-2.yml | 589 +++++++++++++++--- .../fixtures/luna_hostgroup-3.yml | 520 +++++++++++++--- .../fixtures/luna_hostgroup-4.yml | 178 ++++++ .../fixtures/luna_hostgroup-5.yml | 116 ++++ tests/test_playbooks/luna_hostgroup.yml | 25 + tests/test_playbooks/tasks/hostgroup.yml | 1 + 11 files changed, 1643 insertions(+), 605 deletions(-) create mode 100644 changelogs/fragments/1123-ansible-roles-for-hostgroups.yml create mode 100644 tests/test_playbooks/fixtures/luna_hostgroup-4.yml create mode 100644 tests/test_playbooks/fixtures/luna_hostgroup-5.yml diff --git a/changelogs/fragments/1123-ansible-roles-for-hostgroups.yml b/changelogs/fragments/1123-ansible-roles-for-hostgroups.yml new file mode 100644 index 00000000..0195b1c3 --- /dev/null +++ b/changelogs/fragments/1123-ansible-roles-for-hostgroups.yml @@ -0,0 +1,2 @@ +minor_changes: + - hostgroup - add a ``ansible_roles`` parameter (https://github.com/theforeman/foreman-ansible-modules/issues/1123) diff --git a/plugins/module_utils/foreman_helper.py b/plugins/module_utils/foreman_helper.py index 130dcd4d..ec99fe30 100644 --- a/plugins/module_utils/foreman_helper.py +++ b/plugins/module_utils/foreman_helper.py @@ -56,6 +56,7 @@ parameter_ansible_spec = {k: v for (k, v) in parameter_foreman_spec.items() if k != 'id'} _PLUGIN_RESOURCES = { + 'ansible': 'ansible_roles', 'discovery': 'discovery_rules', 'katello': 'subscriptions', 'openscap': 'scap_contents', diff --git a/plugins/modules/hostgroup.py b/plugins/modules/hostgroup.py index d0c37077..73f0cae9 100644 --- a/plugins/modules/hostgroup.py +++ b/plugins/modules/hostgroup.py @@ -55,6 +55,14 @@ parameters: description: - Hostgroup specific host parameters + ansible_roles: + description: + - A list of ansible roles to associate with the hostgroup. + - The foreman-ansible plugin must be installed to use this parameter. + required: false + type: list + elements: str + version_added: 2.1.0 extends_documentation_fragment: - theforeman.foreman.foreman - theforeman.foreman.foreman.entity_state @@ -159,6 +167,7 @@ def main(): name=dict(required=True), description=dict(), parent=dict(type='entity'), + ansible_roles=dict(type='entity_list', ensure=False), organization=dict(type='entity', required=False, ensure=False), ), argument_spec=dict( @@ -169,10 +178,12 @@ def main(): content_view=('organization',), lifecycle_environment=('organization',), ), + required_plugins=[('ansible', ['ansible_roles'])], ) module_params = module.foreman_params with module.api_connection(): + old_entity = module.lookup_entity('entity') if not module.desired_absent: if 'organization' in module_params: if 'organizations' in module_params: @@ -182,9 +193,25 @@ def main(): module_params['organizations'] = [module_params['organization']] expected_puppetclasses = module_params.pop('puppetclasses', None) entity = module.run() + if not module.desired_absent and 'environment_id' in entity: ensure_puppetclasses(module, 'hostgroup', entity, expected_puppetclasses) + ansible_roles = module_params.get('ansible_roles') + if not module.desired_absent and ansible_roles is not None: + desired_ansible_role_ids = [item['id'] for item in ansible_roles] + current_ansible_role_ids = [ + item['id'] for item in module.resource_action( + 'hostgroups', 'ansible_roles', {'id': entity['id']}, + ignore_check_mode=True, record_change=False, + ) + ] if old_entity else [] + if set(current_ansible_role_ids) != set(desired_ansible_role_ids): + module.resource_action( + 'hostgroups', 'assign_ansible_roles', + {'id': entity['id'], 'ansible_role_ids': desired_ansible_role_ids}, + ) + if __name__ == '__main__': main() diff --git a/tests/test_playbooks/fixtures/luna_hostgroup-0.yml b/tests/test_playbooks/fixtures/luna_hostgroup-0.yml index e549e04f..1a673735 100644 --- a/tests/test_playbooks/fixtures/luna_hostgroup-0.yml +++ b/tests/test_playbooks/fixtures/luna_hostgroup-0.yml @@ -11,27 +11,21 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/status + uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"1.23.1","api_version":2}' + string: '{"result":"ok","status":200,"version":"2.5.0-develop","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive - Content-Length: - - '63' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:25 GMT - ETag: - - W/"f26fab35869f9a602399f2f56dc6b2ef" Foreman_api_version: - '2' Foreman_current_location: @@ -39,17 +33,13 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=10000 - Server: - - Apache - Set-Cookie: - - _session_id=9e49259ab342731e8c6c34d46e7d4b13; path=/; secure; HttpOnly; SameSite=Lax - Status: - - 200 OK + - timeout=15, max=100 Strict-Transport-Security: - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -58,14 +48,10 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - c6b3d20e-3994-45c6-9ca0-d3379021a6ec - X-Runtime: - - '0.103037' X-XSS-Protection: - 1; mode=block + content-length: + - '70' status: code: 200 message: OK @@ -78,12 +64,10 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=9e49259ab342731e8c6c34d46e7d4b13 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 + uri: https://foreman.example.org/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 response: body: string: "{\n \"total\": 0,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\": @@ -96,14 +80,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:25 GMT - ETag: - - W/"396d8c1d0d394fdd698ebcb071369922-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -111,13 +91,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9999 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=99 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -130,12 +106,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - bbd71b7b-9a0d-4b8c-bf91-4cd882411dbf - X-Runtime: - - '0.016505' X-XSS-Protection: - 1; mode=block content-length: @@ -152,18 +122,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=9e49259ab342731e8c6c34d46e7d4b13 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/katello/api/organizations?search=name%3D%22Test+Org1%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Org1%22&per_page=4294967296 response: body: string: "{\n \"total\": 3,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Org1\\\"\",\n \"sort\": {\n \"by\": - null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org1\",\"created_at\":\"2019-12-09 - 14:27:45 UTC\",\"updated_at\":\"2019-12-09 14:27:45 UTC\",\"id\":11,\"name\":\"Test + null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org1\",\"created_at\":\"2021-03-16 + 17:51:17 UTC\",\"updated_at\":\"2021-03-16 17:51:17 UTC\",\"id\":14,\"name\":\"Test Org1\",\"title\":\"Test Org1\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -172,14 +140,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:25 GMT - ETag: - - W/"6be3309e4f3f4f9ae6dea3a2986eca25-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -187,13 +151,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9998 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=98 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -206,12 +166,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - aa575e02-7eab-41c9-9b0c-a88d17d7096d - X-Runtime: - - '0.016634' X-XSS-Protection: - 1; mode=block content-length: @@ -228,18 +182,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=9e49259ab342731e8c6c34d46e7d4b13 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/katello/api/organizations?search=name%3D%22Test+Org2%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Org2%22&per_page=4294967296 response: body: string: "{\n \"total\": 3,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Org2\\\"\",\n \"sort\": {\n \"by\": - null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org2\",\"created_at\":\"2019-12-09 - 14:28:22 UTC\",\"updated_at\":\"2019-12-09 14:28:22 UTC\",\"id\":15,\"name\":\"Test + null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org2\",\"created_at\":\"2021-03-16 + 17:51:19 UTC\",\"updated_at\":\"2021-03-16 17:51:19 UTC\",\"id\":15,\"name\":\"Test Org2\",\"title\":\"Test Org2\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -248,14 +200,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:25 GMT - ETag: - - W/"41a1ec65a1e49713133c4a5bdaeb0bc9-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -263,13 +211,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9997 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -282,12 +226,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 1ad8618e-d1a8-4059-a889-a0027921e15e - X-Runtime: - - '0.017133' X-XSS-Protection: - 1; mode=block content-length: @@ -304,18 +242,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=9e49259ab342731e8c6c34d46e7d4b13 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/locations?search=title%3D%22Foo%22&per_page=4294967296 + uri: https://foreman.example.org/api/locations?search=title%3D%22Foo%22&per_page=4294967296 response: body: string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"title=\\\"Foo\\\"\",\n \"sort\": {\n \"by\": - null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2019-12-09 - 14:27:41 UTC\",\"updated_at\":\"2019-12-09 14:27:41 UTC\",\"id\":8,\"name\":\"Foo\",\"title\":\"Foo\",\"description\":null}]\n}\n" + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2021-03-16 + 10:51:22 UTC\",\"updated_at\":\"2021-03-16 10:51:22 UTC\",\"id\":3,\"name\":\"Foo\",\"title\":\"Foo\",\"description\":null}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -323,14 +259,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:25 GMT - ETag: - - W/"b32456db3271cb146cf5ccc3cf7fab5b-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -338,13 +270,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9996 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -357,12 +285,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - ecf7268f-0a96-4c36-993b-841de6f09a86 - X-Runtime: - - '0.016500' X-XSS-Protection: - 1; mode=block content-length: @@ -379,18 +301,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=9e49259ab342731e8c6c34d46e7d4b13 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/locations?search=title%3D%22Foo%2FBaz%22&per_page=4294967296 + uri: https://foreman.example.org/api/locations?search=title%3D%22Foo%2FBaz%22&per_page=4294967296 response: body: string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"title=\\\"Foo/Baz\\\"\",\n \"sort\": {\n \"by\": - null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":\"8\",\"parent_id\":8,\"parent_name\":\"Foo\",\"created_at\":\"2019-12-09 - 14:28:19 UTC\",\"updated_at\":\"2019-12-09 14:28:19 UTC\",\"id\":13,\"name\":\"Baz\",\"title\":\"Foo/Baz\",\"description\":null}]\n}\n" + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":\"3\",\"parent_id\":3,\"parent_name\":\"Foo\",\"created_at\":\"2021-03-16 + 17:51:14 UTC\",\"updated_at\":\"2021-03-16 17:51:14 UTC\",\"id\":12,\"name\":\"Baz\",\"title\":\"Foo/Baz\",\"description\":null}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -398,14 +318,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:25 GMT - ETag: - - W/"d91a838de591999dd2cfce0812d21285-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -413,13 +329,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9995 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=95 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -432,12 +344,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 2e6b6ea8-b160-4909-8729-d205a76a5349 - X-Runtime: - - '0.023232' X-XSS-Protection: - 1; mode=block content-length: @@ -454,18 +360,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=9e49259ab342731e8c6c34d46e7d4b13 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/locations?search=title%3D%22Bar%22&per_page=4294967296 + uri: https://foreman.example.org/api/locations?search=title%3D%22Bar%22&per_page=4294967296 response: body: string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"title=\\\"Bar\\\"\",\n \"sort\": {\n \"by\": - null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2019-12-09 - 14:28:20 UTC\",\"updated_at\":\"2019-12-09 14:28:20 UTC\",\"id\":14,\"name\":\"Bar\",\"title\":\"Bar\",\"description\":null}]\n}\n" + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2021-03-16 + 17:51:15 UTC\",\"updated_at\":\"2021-03-16 17:51:15 UTC\",\"id\":13,\"name\":\"Bar\",\"title\":\"Bar\",\"description\":null}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -473,14 +377,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:25 GMT - ETag: - - W/"8f94aad972ec85a9889d19c811d9a6c9-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -488,13 +388,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9994 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=94 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -507,12 +403,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - bf69bd52-4978-4513-91b6-1b161c5165b2 - X-Runtime: - - '0.017449' X-XSS-Protection: - 1; mode=block content-length: @@ -529,19 +419,20 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=9e49259ab342731e8c6c34d46e7d4b13 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/smart_proxies?search=name%3D%22katello.example.com%22&per_page=4294967296 + uri: https://foreman.example.org/api/smart_proxies?search=name%3D%22centos7-luna.shu.example.com%22&per_page=4294967296 response: body: string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"name=\\\"katello.example.com\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"created_at\":\"2019-12-05 - 15:08:34 UTC\",\"updated_at\":\"2019-12-05 15:08:34 UTC\",\"name\":\"katello.example.com\",\"id\":1,\"url\":\"https://katello.example.com:9090\",\"download_policy\":\"on_demand\",\"features\":[{\"capabilities\":[],\"name\":\"Pulp\",\"id\":2},{\"capabilities\":[],\"name\":\"Openscap\",\"id\":16},{\"capabilities\":[],\"name\":\"DNS\",\"id\":6},{\"capabilities\":[],\"name\":\"Templates\",\"id\":1},{\"capabilities\":[],\"name\":\"TFTP\",\"id\":5},{\"capabilities\":[],\"name\":\"Puppet - CA\",\"id\":9},{\"capabilities\":[],\"name\":\"Puppet\",\"id\":8},{\"capabilities\":[],\"name\":\"BMC\",\"id\":10},{\"capabilities\":[],\"name\":\"Logs\",\"id\":13},{\"capabilities\":[],\"name\":\"HTTPBoot\",\"id\":14}]}]\n}\n" + 4294967296,\n \"search\": \"name=\\\"centos7-luna.shu.example.com\\\"\",\n + \ \"sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": + [{\"created_at\":\"2021-03-16 10:03:09 UTC\",\"updated_at\":\"2021-03-16 10:03:15 + UTC\",\"name\":\"centos7-luna.shu.example.com\",\"id\":1,\"url\":\"https://centos7-luna.shu.example.com:9090\",\"remote_execution_pubkey\":\"ssh-rsa + AAAAB3NzaC1yc2EAAAADAQABAAABAQDR75cBKgge8EKlwZWAPjpdeE3uT/kV7c4NoGWButu5CwiOXV7tri8+af0DUi8wx9VjdPmxxJQDpo8NxA4dnEUlxDBsezKXdRj09da9c/fyI8no4AmcjgYyHpR2UnMLGXuxwVy9+fiLMhzeQWj6Mxp7mVv+73MfsYV+z3UFHW5H25YXiz2njbhG+gWAE8ozWWApt2QFyyKXS40be7sXVYwu6njIaUIoA9J7FxO4gTbT2/IpiPuDFJiotqmkqkQIBQEWco8Amj6OZAjhj9St3OaVSkLLZXv7HugecuQTkhbrFVzOj2rkwonfY8ZpjrdkBWD7cQVC4idKh9CHsmnLYqlZ + foreman-proxy@centos7-luna.shu.example.com\",\"download_policy\":\"on_demand\",\"supported_pulp_types\":{\"pulp2\":{\"supported_types\":[]},\"pulp3\":{\"supported_types\":[\"deb\",\"docker\",\"file\",\"yum\"],\"overriden_to_pulp2\":[]}},\"features\":[{\"capabilities\":[],\"name\":\"Discovery\",\"id\":20},{\"capabilities\":[],\"name\":\"Dynflow\",\"id\":18},{\"capabilities\":[],\"name\":\"Ansible\",\"id\":21},{\"capabilities\":[],\"name\":\"Openscap\",\"id\":22},{\"capabilities\":[],\"name\":\"SSH\",\"id\":19},{\"capabilities\":[\"pulp_certguard\",\"pulp_container\",\"pulp_deb\",\"pulp_file\",\"pulp_rpm\",\"pulpcore\"],\"name\":\"Pulpcore\",\"id\":4},{\"capabilities\":[],\"name\":\"Puppet + CA\",\"id\":10},{\"capabilities\":[],\"name\":\"Puppet\",\"id\":9},{\"capabilities\":[],\"name\":\"Logs\",\"id\":14},{\"capabilities\":[],\"name\":\"Registration\",\"id\":17}]}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -549,14 +440,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:25 GMT - ETag: - - W/"3a5fc619df20901ef30103310c325482-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -564,13 +451,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9993 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=93 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -583,16 +466,10 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 5d0e6bb6-342c-41e6-bd59-6ed8562c9fba - X-Runtime: - - '0.026756' X-XSS-Protection: - 1; mode=block content-length: - - '816' + - '1530' status: code: 200 message: OK @@ -605,17 +482,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=9e49259ab342731e8c6c34d46e7d4b13 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 + uri: https://foreman.example.org/ansible/api/ansible_roles?search=name%3D%22thulium_drake.motd%22&per_page=4294967296 response: body: - string: "{\n \"total\": 0,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"title=\\\"New host group\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": []\n}\n" + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"thulium_drake.motd\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"id\":1,\"name\":\"thulium_drake.motd\",\"created_at\":\"2021-03-16 + 10:23:34 UTC\",\"updated_at\":\"2021-03-16 10:23:34 UTC\"}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -623,14 +499,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:25 GMT - ETag: - - W/"396d8c1d0d394fdd698ebcb071369922-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -638,13 +510,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9992 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=92 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -657,22 +525,16 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 367e6f71-0b9b-4694-bbc8-2ff43efef20f - X-Runtime: - - '0.020480' X-XSS-Protection: - 1; mode=block content-length: - - '181' + - '298' status: code: 200 message: OK - request: body: '{"hostgroup": {"name": "New host group", "openscap_proxy_id": 1, "location_ids": - [8, 13, 14], "organization_ids": [11, 15]}}' + [3, 12, 13], "organization_ids": [14, 15]}}' headers: Accept: - application/json;version=2 @@ -684,17 +546,15 @@ interactions: - '124' Content-Type: - application/json - Cookie: - - _session_id=9e49259ab342731e8c6c34d46e7d4b13 User-Agent: - apypie (https://github.com/Apipie/apypie) method: POST - uri: https://katello.example.com/api/hostgroups + uri: https://foreman.example.org/api/hostgroups response: body: - string: '{"subnet_id":null,"subnet_name":null,"operatingsystem_id":null,"operatingsystem_name":null,"domain_id":null,"domain_name":null,"environment_id":null,"environment_name":null,"compute_profile_id":null,"compute_profile_name":null,"ancestry":null,"parent_id":null,"parent_name":null,"ptable_id":null,"ptable_name":null,"medium_id":null,"medium_name":null,"pxe_loader":null,"subnet6_id":null,"subnet6_name":null,"compute_resource_id":null,"compute_resource_name":null,"architecture_id":null,"architecture_name":null,"realm_id":null,"realm_name":null,"created_at":"2019-12-09 - 14:28:25 UTC","updated_at":"2019-12-09 14:28:25 UTC","id":8,"name":"New host - group","title":"New host group","description":null,"puppet_proxy_id":null,"puppet_proxy_name":null,"puppet_ca_proxy_id":null,"puppet_ca_proxy_name":null,"openscap_proxy_id":1,"openscap_proxy_name":"katello.example.com","puppet_proxy":null,"puppet_ca_proxy":null,"openscap_proxy":{"name":"katello.example.com","id":1,"url":"https://katello.example.com:9090"},"parameters":[],"template_combinations":[],"puppetclasses":[],"config_groups":[],"all_puppetclasses":[],"locations":[{"id":8,"name":"Foo","title":"Foo","description":null},{"id":13,"name":"Baz","title":"Foo/Baz","description":null},{"id":14,"name":"Bar","title":"Bar","description":null}],"organizations":[{"id":11,"name":"Test + string: '{"subnet_id":null,"subnet_name":null,"operatingsystem_id":null,"operatingsystem_name":null,"domain_id":null,"domain_name":null,"environment_id":null,"environment_name":null,"compute_profile_id":null,"compute_profile_name":null,"ancestry":null,"parent_id":null,"parent_name":null,"ptable_id":null,"ptable_name":null,"medium_id":null,"medium_name":null,"pxe_loader":null,"subnet6_id":null,"subnet6_name":null,"compute_resource_id":null,"compute_resource_name":null,"architecture_id":null,"architecture_name":null,"realm_id":null,"realm_name":null,"created_at":"2021-03-16 + 17:51:22 UTC","updated_at":"2021-03-16 17:51:22 UTC","id":10,"name":"New host + group","title":"New host group","description":null,"puppet_proxy_id":null,"puppet_proxy_name":null,"puppet_ca_proxy_id":null,"puppet_ca_proxy_name":null,"openscap_proxy_id":1,"openscap_proxy_name":"centos7-luna.shu.example.com","puppet_proxy":null,"puppet_ca_proxy":null,"openscap_proxy":{"name":"centos7-luna.shu.example.com","id":1,"url":"https://centos7-luna.shu.example.com:9090"},"inherited_compute_profile_id":null,"inherited_environment_id":null,"inherited_domain_id":null,"inherited_puppet_proxy_id":null,"inherited_puppet_ca_proxy_id":null,"inherited_compute_resource_id":null,"inherited_operatingsystem_id":null,"inherited_architecture_id":null,"inherited_medium_id":null,"inherited_ptable_id":null,"inherited_subnet_id":null,"inherited_subnet6_id":null,"inherited_realm_id":null,"inherited_pxe_loader":null,"parameters":[],"template_combinations":[],"puppetclasses":[],"config_groups":[],"all_puppetclasses":[],"locations":[{"id":3,"name":"Foo","title":"Foo","description":null},{"id":12,"name":"Baz","title":"Foo/Baz","description":null},{"id":13,"name":"Bar","title":"Bar","description":null}],"organizations":[{"id":14,"name":"Test Org1","title":"Test Org1","description":"A test organization"},{"id":15,"name":"Test Org2","title":"Test Org2","description":"A test organization"}]}' headers: @@ -704,14 +564,70 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=91 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +- request: + body: '{"ansible_role_ids": [1]}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '25' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/api/hostgroups/10/assign_ansible_roles + response: + body: + string: '{"id":10,"name":"New host group","created_at":"2021-03-16T17:51:22.493Z","updated_at":"2021-03-16T17:51:22.493Z","environment_id":null,"operatingsystem_id":null,"architecture_id":null,"medium_id":null,"ptable_id":null,"root_pass":null,"puppet_ca_proxy_id":null,"use_image":null,"image_file":"","ancestry":null,"vm_defaults":null,"subnet_id":null,"domain_id":null,"puppet_proxy_id":null,"title":"New + host group","realm_id":null,"compute_profile_id":null,"grub_pass":"","lookup_value_matcher":"hostgroup=New + host group","openscap_proxy_id":1,"subnet6_id":null,"pxe_loader":null,"description":null,"compute_resource_id":null}' + 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-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:25 GMT - ETag: - - W/"d14c874e8f208ea237cc47d26fe71163" Foreman_api_version: - '2' Foreman_current_location: @@ -719,15 +635,11 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9991 - Server: - - Apache - Set-Cookie: - - request_method=POST; path=/; secure; HttpOnly; SameSite=Lax - Status: - - 201 Created + - timeout=15, max=90 + Location: + - https://centos7-luna/hostgroups/10-New%20host%20group Strict-Transport-Security: - max-age=631139040; includeSubdomains Transfer-Encoding: @@ -740,12 +652,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 5f7376cc-eba7-48cf-8869-88593c4127fe - X-Runtime: - - '0.103796' X-XSS-Protection: - 1; mode=block status: diff --git a/tests/test_playbooks/fixtures/luna_hostgroup-1.yml b/tests/test_playbooks/fixtures/luna_hostgroup-1.yml index 04d0eb28..4600788c 100644 --- a/tests/test_playbooks/fixtures/luna_hostgroup-1.yml +++ b/tests/test_playbooks/fixtures/luna_hostgroup-1.yml @@ -11,27 +11,21 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/status + uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"1.23.1","api_version":2}' + string: '{"result":"ok","status":200,"version":"2.5.0-develop","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive - Content-Length: - - '63' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:26 GMT - ETag: - - W/"f26fab35869f9a602399f2f56dc6b2ef" Foreman_api_version: - '2' Foreman_current_location: @@ -39,17 +33,13 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=10000 - Server: - - Apache - Set-Cookie: - - _session_id=6ba38324430d49d1dc8f18ab07ec7b05; path=/; secure; HttpOnly; SameSite=Lax - Status: - - 200 OK + - timeout=15, max=100 Strict-Transport-Security: - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -58,14 +48,10 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - fce038b6-4102-4239-a3e0-63c1dd731a17 - X-Runtime: - - '0.097967' X-XSS-Protection: - 1; mode=block + content-length: + - '70' status: code: 200 message: OK @@ -78,19 +64,17 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=6ba38324430d49d1dc8f18ab07ec7b05 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 + uri: https://foreman.example.org/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 response: body: string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"title=\\\"New host group\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"subnet_id\":null,\"subnet_name\":null,\"operatingsystem_id\":null,\"operatingsystem_name\":null,\"domain_id\":null,\"domain_name\":null,\"environment_id\":null,\"environment_name\":null,\"compute_profile_id\":null,\"compute_profile_name\":null,\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"ptable_id\":null,\"ptable_name\":null,\"medium_id\":null,\"medium_name\":null,\"pxe_loader\":null,\"subnet6_id\":null,\"subnet6_name\":null,\"compute_resource_id\":null,\"compute_resource_name\":null,\"architecture_id\":null,\"architecture_name\":null,\"realm_id\":null,\"realm_name\":null,\"created_at\":\"2019-12-09 - 14:28:25 UTC\",\"updated_at\":\"2019-12-09 14:28:25 UTC\",\"id\":8,\"name\":\"New - host group\",\"title\":\"New host group\",\"description\":null,\"puppet_proxy_id\":null,\"puppet_proxy_name\":null,\"puppet_ca_proxy_id\":null,\"puppet_ca_proxy_name\":null,\"openscap_proxy_id\":1,\"openscap_proxy_name\":\"katello.example.com\",\"puppet_proxy\":null,\"puppet_ca_proxy\":null,\"openscap_proxy\":{\"name\":\"katello.example.com\",\"id\":1,\"url\":\"https://katello.example.com:9090\"}}]\n}\n" + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"subnet_id\":null,\"subnet_name\":null,\"operatingsystem_id\":null,\"operatingsystem_name\":null,\"domain_id\":null,\"domain_name\":null,\"environment_id\":null,\"environment_name\":null,\"compute_profile_id\":null,\"compute_profile_name\":null,\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"ptable_id\":null,\"ptable_name\":null,\"medium_id\":null,\"medium_name\":null,\"pxe_loader\":null,\"subnet6_id\":null,\"subnet6_name\":null,\"compute_resource_id\":null,\"compute_resource_name\":null,\"architecture_id\":null,\"architecture_name\":null,\"realm_id\":null,\"realm_name\":null,\"created_at\":\"2021-03-16 + 17:51:22 UTC\",\"updated_at\":\"2021-03-16 17:51:22 UTC\",\"id\":10,\"name\":\"New + host group\",\"title\":\"New host group\",\"description\":null,\"puppet_proxy_id\":null,\"puppet_proxy_name\":null,\"puppet_ca_proxy_id\":null,\"puppet_ca_proxy_name\":null,\"openscap_proxy_id\":1,\"openscap_proxy_name\":\"centos7-luna.shu.example.com\",\"puppet_proxy\":null,\"puppet_ca_proxy\":null,\"openscap_proxy\":{\"name\":\"centos7-luna.shu.example.com\",\"id\":1,\"url\":\"https://centos7-luna.shu.example.com:9090\"},\"inherited_compute_profile_id\":null,\"inherited_environment_id\":null,\"inherited_domain_id\":null,\"inherited_puppet_proxy_id\":null,\"inherited_puppet_ca_proxy_id\":null,\"inherited_compute_resource_id\":null,\"inherited_operatingsystem_id\":null,\"inherited_architecture_id\":null,\"inherited_medium_id\":null,\"inherited_ptable_id\":null,\"inherited_subnet_id\":null,\"inherited_subnet6_id\":null,\"inherited_realm_id\":null,\"inherited_pxe_loader\":null}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -98,14 +82,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:26 GMT - ETag: - - W/"394598f0443d35f9f3cce12dd4130659-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -113,13 +93,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9999 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=99 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -132,16 +108,10 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 1f9165a4-c772-4452-8131-f0651a8e2c94 - X-Runtime: - - '0.022047' X-XSS-Protection: - 1; mode=block content-length: - - '1186' + - '1647' status: code: 200 message: OK @@ -154,17 +124,15 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=6ba38324430d49d1dc8f18ab07ec7b05 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/hostgroups/8 + uri: https://foreman.example.org/api/hostgroups/10 response: body: - string: '{"content_source_id":null,"content_source_name":null,"content_view_id":null,"content_view_name":null,"lifecycle_environment_id":null,"lifecycle_environment_name":null,"kickstart_repository_id":null,"kickstart_repository_name":null,"subnet_id":null,"subnet_name":null,"operatingsystem_id":null,"operatingsystem_name":null,"domain_id":null,"domain_name":null,"environment_id":null,"environment_name":null,"compute_profile_id":null,"compute_profile_name":null,"ancestry":null,"parent_id":null,"parent_name":null,"ptable_id":null,"ptable_name":null,"medium_id":null,"medium_name":null,"pxe_loader":null,"subnet6_id":null,"subnet6_name":null,"compute_resource_id":null,"compute_resource_name":null,"architecture_id":null,"architecture_name":null,"realm_id":null,"realm_name":null,"created_at":"2019-12-09 - 14:28:25 UTC","updated_at":"2019-12-09 14:28:25 UTC","id":8,"name":"New host - group","title":"New host group","description":null,"puppet_proxy_id":null,"puppet_proxy_name":null,"puppet_ca_proxy_id":null,"puppet_ca_proxy_name":null,"openscap_proxy_id":1,"openscap_proxy_name":"katello.example.com","puppet_proxy":null,"puppet_ca_proxy":null,"openscap_proxy":{"name":"katello.example.com","id":1,"url":"https://katello.example.com:9090"},"parameters":[],"template_combinations":[],"puppetclasses":[],"config_groups":[],"all_puppetclasses":[],"locations":[{"id":14,"name":"Bar","title":"Bar","description":null},{"id":8,"name":"Foo","title":"Foo","description":null},{"id":13,"name":"Baz","title":"Foo/Baz","description":null}],"organizations":[{"id":11,"name":"Test + string: '{"content_source_id":null,"content_source_name":null,"content_view_id":null,"content_view_name":null,"lifecycle_environment_id":null,"lifecycle_environment_name":null,"kickstart_repository_id":null,"subnet_id":null,"subnet_name":null,"operatingsystem_id":null,"operatingsystem_name":null,"domain_id":null,"domain_name":null,"environment_id":null,"environment_name":null,"compute_profile_id":null,"compute_profile_name":null,"ancestry":null,"parent_id":null,"parent_name":null,"ptable_id":null,"ptable_name":null,"medium_id":null,"medium_name":null,"pxe_loader":null,"subnet6_id":null,"subnet6_name":null,"compute_resource_id":null,"compute_resource_name":null,"architecture_id":null,"architecture_name":null,"realm_id":null,"realm_name":null,"created_at":"2021-03-16 + 17:51:22 UTC","updated_at":"2021-03-16 17:51:22 UTC","id":10,"name":"New host + group","title":"New host group","description":null,"puppet_proxy_id":null,"puppet_proxy_name":null,"puppet_ca_proxy_id":null,"puppet_ca_proxy_name":null,"openscap_proxy_id":1,"openscap_proxy_name":"centos7-luna.shu.example.com","puppet_proxy":null,"puppet_ca_proxy":null,"openscap_proxy":{"name":"centos7-luna.shu.example.com","id":1,"url":"https://centos7-luna.shu.example.com:9090"},"inherited_compute_profile_id":null,"inherited_environment_id":null,"inherited_domain_id":null,"inherited_puppet_proxy_id":null,"inherited_puppet_ca_proxy_id":null,"inherited_compute_resource_id":null,"inherited_operatingsystem_id":null,"inherited_architecture_id":null,"inherited_medium_id":null,"inherited_ptable_id":null,"inherited_subnet_id":null,"inherited_subnet6_id":null,"inherited_realm_id":null,"inherited_pxe_loader":null,"parameters":[],"template_combinations":[],"puppetclasses":[],"config_groups":[],"all_puppetclasses":[],"locations":[{"id":13,"name":"Bar","title":"Bar","description":null},{"id":3,"name":"Foo","title":"Foo","description":null},{"id":12,"name":"Baz","title":"Foo/Baz","description":null}],"organizations":[{"id":14,"name":"Test Org1","title":"Test Org1","description":"A test organization"},{"id":15,"name":"Test Org2","title":"Test Org2","description":"A test organization"}]}' headers: @@ -174,14 +142,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:26 GMT - ETag: - - W/"4a81d7b5e343dc38739f2882cb23b770-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -189,13 +153,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9998 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=98 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -208,16 +168,10 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 0d6d5a40-6de0-4ef0-b097-75f639f0639e - X-Runtime: - - '0.038008' X-XSS-Protection: - 1; mode=block content-length: - - '1712' + - '2140' status: code: 200 message: OK @@ -230,18 +184,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=6ba38324430d49d1dc8f18ab07ec7b05 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/katello/api/organizations?search=name%3D%22Test+Org1%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Org1%22&per_page=4294967296 response: body: string: "{\n \"total\": 3,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Org1\\\"\",\n \"sort\": {\n \"by\": - null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org1\",\"created_at\":\"2019-12-09 - 14:27:45 UTC\",\"updated_at\":\"2019-12-09 14:27:45 UTC\",\"id\":11,\"name\":\"Test + null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org1\",\"created_at\":\"2021-03-16 + 17:51:17 UTC\",\"updated_at\":\"2021-03-16 17:51:17 UTC\",\"id\":14,\"name\":\"Test Org1\",\"title\":\"Test Org1\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -250,14 +202,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:26 GMT - ETag: - - W/"6be3309e4f3f4f9ae6dea3a2986eca25-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -265,13 +213,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9997 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=97 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -284,12 +228,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 3fd538d9-6809-4b0f-9906-f5c877e9f68e - X-Runtime: - - '0.017225' X-XSS-Protection: - 1; mode=block content-length: @@ -306,18 +244,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=6ba38324430d49d1dc8f18ab07ec7b05 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/katello/api/organizations?search=name%3D%22Test+Org2%22&per_page=4294967296 + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Org2%22&per_page=4294967296 response: body: string: "{\n \"total\": 3,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"name=\\\"Test Org2\\\"\",\n \"sort\": {\n \"by\": - null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org2\",\"created_at\":\"2019-12-09 - 14:28:22 UTC\",\"updated_at\":\"2019-12-09 14:28:22 UTC\",\"id\":15,\"name\":\"Test + null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org2\",\"created_at\":\"2021-03-16 + 17:51:19 UTC\",\"updated_at\":\"2021-03-16 17:51:19 UTC\",\"id\":15,\"name\":\"Test Org2\",\"title\":\"Test Org2\",\"description\":\"A test organization\"}]\n}\n" headers: Cache-Control: @@ -326,14 +262,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:26 GMT - ETag: - - W/"41a1ec65a1e49713133c4a5bdaeb0bc9-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -341,13 +273,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9996 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=96 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -360,12 +288,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - e801c6af-0914-4acc-8315-1c498058fa57 - X-Runtime: - - '0.016790' X-XSS-Protection: - 1; mode=block content-length: @@ -382,18 +304,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=6ba38324430d49d1dc8f18ab07ec7b05 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/locations?search=title%3D%22Foo%22&per_page=4294967296 + uri: https://foreman.example.org/api/locations?search=title%3D%22Foo%22&per_page=4294967296 response: body: string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"title=\\\"Foo\\\"\",\n \"sort\": {\n \"by\": - null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2019-12-09 - 14:27:41 UTC\",\"updated_at\":\"2019-12-09 14:27:41 UTC\",\"id\":8,\"name\":\"Foo\",\"title\":\"Foo\",\"description\":null}]\n}\n" + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2021-03-16 + 10:51:22 UTC\",\"updated_at\":\"2021-03-16 10:51:22 UTC\",\"id\":3,\"name\":\"Foo\",\"title\":\"Foo\",\"description\":null}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -401,14 +321,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:26 GMT - ETag: - - W/"b32456db3271cb146cf5ccc3cf7fab5b-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -416,13 +332,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9995 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=95 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -435,12 +347,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 819a0e67-4a69-4a60-835a-9fe14d6aa48b - X-Runtime: - - '0.016222' X-XSS-Protection: - 1; mode=block content-length: @@ -457,18 +363,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=6ba38324430d49d1dc8f18ab07ec7b05 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/locations?search=title%3D%22Foo%2FBaz%22&per_page=4294967296 + uri: https://foreman.example.org/api/locations?search=title%3D%22Foo%2FBaz%22&per_page=4294967296 response: body: string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"title=\\\"Foo/Baz\\\"\",\n \"sort\": {\n \"by\": - null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":\"8\",\"parent_id\":8,\"parent_name\":\"Foo\",\"created_at\":\"2019-12-09 - 14:28:19 UTC\",\"updated_at\":\"2019-12-09 14:28:19 UTC\",\"id\":13,\"name\":\"Baz\",\"title\":\"Foo/Baz\",\"description\":null}]\n}\n" + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":\"3\",\"parent_id\":3,\"parent_name\":\"Foo\",\"created_at\":\"2021-03-16 + 17:51:14 UTC\",\"updated_at\":\"2021-03-16 17:51:14 UTC\",\"id\":12,\"name\":\"Baz\",\"title\":\"Foo/Baz\",\"description\":null}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -476,14 +380,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:26 GMT - ETag: - - W/"d91a838de591999dd2cfce0812d21285-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -491,13 +391,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9994 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=94 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -510,12 +406,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 98bdac06-f9d6-448b-976d-c367bc46c21c - X-Runtime: - - '0.017015' X-XSS-Protection: - 1; mode=block content-length: @@ -532,18 +422,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=6ba38324430d49d1dc8f18ab07ec7b05 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/locations?search=title%3D%22Bar%22&per_page=4294967296 + uri: https://foreman.example.org/api/locations?search=title%3D%22Bar%22&per_page=4294967296 response: body: string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"title=\\\"Bar\\\"\",\n \"sort\": {\n \"by\": - null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2019-12-09 - 14:28:20 UTC\",\"updated_at\":\"2019-12-09 14:28:20 UTC\",\"id\":14,\"name\":\"Bar\",\"title\":\"Bar\",\"description\":null}]\n}\n" + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2021-03-16 + 17:51:15 UTC\",\"updated_at\":\"2021-03-16 17:51:15 UTC\",\"id\":13,\"name\":\"Bar\",\"title\":\"Bar\",\"description\":null}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -551,14 +439,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:26 GMT - ETag: - - W/"8f94aad972ec85a9889d19c811d9a6c9-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -566,13 +450,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9993 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=93 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -585,12 +465,6 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 6fc7024e-06cf-4270-bbfd-a9eedc4c987c - X-Runtime: - - '0.015747' X-XSS-Protection: - 1; mode=block content-length: @@ -607,19 +481,136 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=6ba38324430d49d1dc8f18ab07ec7b05 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/smart_proxies?search=name%3D%22katello.example.com%22&per_page=4294967296 + uri: https://foreman.example.org/api/smart_proxies?search=name%3D%22centos7-luna.shu.example.com%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"centos7-luna.shu.example.com\\\"\",\n + \ \"sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": + [{\"created_at\":\"2021-03-16 10:03:09 UTC\",\"updated_at\":\"2021-03-16 10:03:15 + UTC\",\"name\":\"centos7-luna.shu.example.com\",\"id\":1,\"url\":\"https://centos7-luna.shu.example.com:9090\",\"remote_execution_pubkey\":\"ssh-rsa + AAAAB3NzaC1yc2EAAAADAQABAAABAQDR75cBKgge8EKlwZWAPjpdeE3uT/kV7c4NoGWButu5CwiOXV7tri8+af0DUi8wx9VjdPmxxJQDpo8NxA4dnEUlxDBsezKXdRj09da9c/fyI8no4AmcjgYyHpR2UnMLGXuxwVy9+fiLMhzeQWj6Mxp7mVv+73MfsYV+z3UFHW5H25YXiz2njbhG+gWAE8ozWWApt2QFyyKXS40be7sXVYwu6njIaUIoA9J7FxO4gTbT2/IpiPuDFJiotqmkqkQIBQEWco8Amj6OZAjhj9St3OaVSkLLZXv7HugecuQTkhbrFVzOj2rkwonfY8ZpjrdkBWD7cQVC4idKh9CHsmnLYqlZ + foreman-proxy@centos7-luna.shu.example.com\",\"download_policy\":\"on_demand\",\"supported_pulp_types\":{\"pulp2\":{\"supported_types\":[]},\"pulp3\":{\"supported_types\":[\"deb\",\"docker\",\"file\",\"yum\"],\"overriden_to_pulp2\":[]}},\"features\":[{\"capabilities\":[],\"name\":\"Discovery\",\"id\":20},{\"capabilities\":[],\"name\":\"Dynflow\",\"id\":18},{\"capabilities\":[],\"name\":\"Ansible\",\"id\":21},{\"capabilities\":[],\"name\":\"Openscap\",\"id\":22},{\"capabilities\":[],\"name\":\"SSH\",\"id\":19},{\"capabilities\":[\"pulp_certguard\",\"pulp_container\",\"pulp_deb\",\"pulp_file\",\"pulp_rpm\",\"pulpcore\"],\"name\":\"Pulpcore\",\"id\":4},{\"capabilities\":[],\"name\":\"Puppet + CA\",\"id\":10},{\"capabilities\":[],\"name\":\"Puppet\",\"id\":9},{\"capabilities\":[],\"name\":\"Logs\",\"id\":14},{\"capabilities\":[],\"name\":\"Registration\",\"id\":17}]}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=92 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1530' + 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/ansible/api/ansible_roles?search=name%3D%22thulium_drake.motd%22&per_page=4294967296 response: body: string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"name=\\\"katello.example.com\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"created_at\":\"2019-12-05 - 15:08:34 UTC\",\"updated_at\":\"2019-12-05 15:08:34 UTC\",\"name\":\"katello.example.com\",\"id\":1,\"url\":\"https://katello.example.com:9090\",\"download_policy\":\"on_demand\",\"features\":[{\"capabilities\":[],\"name\":\"Pulp\",\"id\":2},{\"capabilities\":[],\"name\":\"Openscap\",\"id\":16},{\"capabilities\":[],\"name\":\"DNS\",\"id\":6},{\"capabilities\":[],\"name\":\"Templates\",\"id\":1},{\"capabilities\":[],\"name\":\"TFTP\",\"id\":5},{\"capabilities\":[],\"name\":\"Puppet - CA\",\"id\":9},{\"capabilities\":[],\"name\":\"Puppet\",\"id\":8},{\"capabilities\":[],\"name\":\"BMC\",\"id\":10},{\"capabilities\":[],\"name\":\"Logs\",\"id\":13},{\"capabilities\":[],\"name\":\"HTTPBoot\",\"id\":14}]}]\n}\n" + 4294967296,\n \"search\": \"name=\\\"thulium_drake.motd\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"id\":1,\"name\":\"thulium_drake.motd\",\"created_at\":\"2021-03-16 + 10:23:34 UTC\",\"updated_at\":\"2021-03-16 10:23:34 UTC\"}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=91 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '298' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hostgroups/10/ansible_roles + response: + body: + string: '[{"id":1,"name":"thulium_drake.motd","created_at":"2021-03-16 10:23:34 + UTC","updated_at":"2021-03-16 10:23:34 UTC"}]' headers: Cache-Control: - max-age=0, private, must-revalidate @@ -627,14 +618,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:26 GMT - ETag: - - W/"3a5fc619df20901ef30103310c325482-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -642,13 +629,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9992 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=90 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -661,16 +644,10 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 89e4cfdb-7598-411a-b588-9357137c9918 - X-Runtime: - - '0.022489' X-XSS-Protection: - 1; mode=block content-length: - - '816' + - '116' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/luna_hostgroup-2.yml b/tests/test_playbooks/fixtures/luna_hostgroup-2.yml index 6b6b1734..e3847e0a 100644 --- a/tests/test_playbooks/fixtures/luna_hostgroup-2.yml +++ b/tests/test_playbooks/fixtures/luna_hostgroup-2.yml @@ -11,27 +11,21 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/status + uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"1.23.1","api_version":2}' + string: '{"result":"ok","status":200,"version":"2.5.0-develop","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive - Content-Length: - - '63' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:27 GMT - ETag: - - W/"f26fab35869f9a602399f2f56dc6b2ef" Foreman_api_version: - '2' Foreman_current_location: @@ -39,17 +33,13 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=10000 - Server: - - Apache - Set-Cookie: - - _session_id=1f21c2a34b67a5d96c31904614024b11; path=/; secure; HttpOnly; SameSite=Lax - Status: - - 200 OK + - timeout=15, max=100 Strict-Transport-Security: - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -58,14 +48,10 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 30eb7ef7-d5f8-4cfb-a3dc-f0667e7d39c6 - X-Runtime: - - '0.098008' X-XSS-Protection: - 1; mode=block + content-length: + - '70' status: code: 200 message: OK @@ -78,19 +64,17 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=1f21c2a34b67a5d96c31904614024b11 User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 + uri: https://foreman.example.org/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 response: body: string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"title=\\\"New host group\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"subnet_id\":null,\"subnet_name\":null,\"operatingsystem_id\":null,\"operatingsystem_name\":null,\"domain_id\":null,\"domain_name\":null,\"environment_id\":null,\"environment_name\":null,\"compute_profile_id\":null,\"compute_profile_name\":null,\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"ptable_id\":null,\"ptable_name\":null,\"medium_id\":null,\"medium_name\":null,\"pxe_loader\":null,\"subnet6_id\":null,\"subnet6_name\":null,\"compute_resource_id\":null,\"compute_resource_name\":null,\"architecture_id\":null,\"architecture_name\":null,\"realm_id\":null,\"realm_name\":null,\"created_at\":\"2019-12-09 - 14:28:25 UTC\",\"updated_at\":\"2019-12-09 14:28:25 UTC\",\"id\":8,\"name\":\"New - host group\",\"title\":\"New host group\",\"description\":null,\"puppet_proxy_id\":null,\"puppet_proxy_name\":null,\"puppet_ca_proxy_id\":null,\"puppet_ca_proxy_name\":null,\"openscap_proxy_id\":1,\"openscap_proxy_name\":\"katello.example.com\",\"puppet_proxy\":null,\"puppet_ca_proxy\":null,\"openscap_proxy\":{\"name\":\"katello.example.com\",\"id\":1,\"url\":\"https://katello.example.com:9090\"}}]\n}\n" + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"subnet_id\":null,\"subnet_name\":null,\"operatingsystem_id\":null,\"operatingsystem_name\":null,\"domain_id\":null,\"domain_name\":null,\"environment_id\":null,\"environment_name\":null,\"compute_profile_id\":null,\"compute_profile_name\":null,\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"ptable_id\":null,\"ptable_name\":null,\"medium_id\":null,\"medium_name\":null,\"pxe_loader\":null,\"subnet6_id\":null,\"subnet6_name\":null,\"compute_resource_id\":null,\"compute_resource_name\":null,\"architecture_id\":null,\"architecture_name\":null,\"realm_id\":null,\"realm_name\":null,\"created_at\":\"2021-03-16 + 17:51:22 UTC\",\"updated_at\":\"2021-03-16 17:51:22 UTC\",\"id\":10,\"name\":\"New + host group\",\"title\":\"New host group\",\"description\":null,\"puppet_proxy_id\":null,\"puppet_proxy_name\":null,\"puppet_ca_proxy_id\":null,\"puppet_ca_proxy_name\":null,\"openscap_proxy_id\":1,\"openscap_proxy_name\":\"centos7-luna.shu.example.com\",\"puppet_proxy\":null,\"puppet_ca_proxy\":null,\"openscap_proxy\":{\"name\":\"centos7-luna.shu.example.com\",\"id\":1,\"url\":\"https://centos7-luna.shu.example.com:9090\"},\"inherited_compute_profile_id\":null,\"inherited_environment_id\":null,\"inherited_domain_id\":null,\"inherited_puppet_proxy_id\":null,\"inherited_puppet_ca_proxy_id\":null,\"inherited_compute_resource_id\":null,\"inherited_operatingsystem_id\":null,\"inherited_architecture_id\":null,\"inherited_medium_id\":null,\"inherited_ptable_id\":null,\"inherited_subnet_id\":null,\"inherited_subnet6_id\":null,\"inherited_realm_id\":null,\"inherited_pxe_loader\":null}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -98,14 +82,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:27 GMT - ETag: - - W/"394598f0443d35f9f3cce12dd4130659-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -113,13 +93,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9999 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=99 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -132,16 +108,249 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 457f75fb-5c45-4f9f-aeba-7f118def1416 - X-Runtime: - - '0.018137' X-XSS-Protection: - 1; mode=block content-length: - - '1186' + - '1647' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hostgroups/10 + response: + body: + string: '{"content_source_id":null,"content_source_name":null,"content_view_id":null,"content_view_name":null,"lifecycle_environment_id":null,"lifecycle_environment_name":null,"kickstart_repository_id":null,"subnet_id":null,"subnet_name":null,"operatingsystem_id":null,"operatingsystem_name":null,"domain_id":null,"domain_name":null,"environment_id":null,"environment_name":null,"compute_profile_id":null,"compute_profile_name":null,"ancestry":null,"parent_id":null,"parent_name":null,"ptable_id":null,"ptable_name":null,"medium_id":null,"medium_name":null,"pxe_loader":null,"subnet6_id":null,"subnet6_name":null,"compute_resource_id":null,"compute_resource_name":null,"architecture_id":null,"architecture_name":null,"realm_id":null,"realm_name":null,"created_at":"2021-03-16 + 17:51:22 UTC","updated_at":"2021-03-16 17:51:22 UTC","id":10,"name":"New host + group","title":"New host group","description":null,"puppet_proxy_id":null,"puppet_proxy_name":null,"puppet_ca_proxy_id":null,"puppet_ca_proxy_name":null,"openscap_proxy_id":1,"openscap_proxy_name":"centos7-luna.shu.example.com","puppet_proxy":null,"puppet_ca_proxy":null,"openscap_proxy":{"name":"centos7-luna.shu.example.com","id":1,"url":"https://centos7-luna.shu.example.com:9090"},"inherited_compute_profile_id":null,"inherited_environment_id":null,"inherited_domain_id":null,"inherited_puppet_proxy_id":null,"inherited_puppet_ca_proxy_id":null,"inherited_compute_resource_id":null,"inherited_operatingsystem_id":null,"inherited_architecture_id":null,"inherited_medium_id":null,"inherited_ptable_id":null,"inherited_subnet_id":null,"inherited_subnet6_id":null,"inherited_realm_id":null,"inherited_pxe_loader":null,"parameters":[],"template_combinations":[],"puppetclasses":[],"config_groups":[],"all_puppetclasses":[],"locations":[{"id":13,"name":"Bar","title":"Bar","description":null},{"id":3,"name":"Foo","title":"Foo","description":null},{"id":12,"name":"Baz","title":"Foo/Baz","description":null}],"organizations":[{"id":14,"name":"Test + Org1","title":"Test Org1","description":"A test organization"},{"id":15,"name":"Test + Org2","title":"Test Org2","description":"A test organization"}]}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '2140' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Org1%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 3,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Org1\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org1\",\"created_at\":\"2021-03-16 + 17:51:17 UTC\",\"updated_at\":\"2021-03-16 17:51:17 UTC\",\"id\":14,\"name\":\"Test + Org1\",\"title\":\"Test Org1\",\"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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '357' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Org2%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 3,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Org2\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org2\",\"created_at\":\"2021-03-16 + 17:51:19 UTC\",\"updated_at\":\"2021-03-16 17:51:19 UTC\",\"id\":15,\"name\":\"Test + Org2\",\"title\":\"Test Org2\",\"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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '357' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/locations?search=title%3D%22Foo%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"title=\\\"Foo\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2021-03-16 + 10:51:22 UTC\",\"updated_at\":\"2021-03-16 10:51:22 UTC\",\"id\":3,\"name\":\"Foo\",\"title\":\"Foo\",\"description\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '354' status: code: 200 message: OK @@ -154,19 +363,16 @@ interactions: - gzip, deflate Connection: - keep-alive - Content-Length: - - '0' - Cookie: - - _session_id=1f21c2a34b67a5d96c31904614024b11 User-Agent: - apypie (https://github.com/Apipie/apypie) - method: DELETE - uri: https://katello.example.com/api/hostgroups/8 + method: GET + uri: https://foreman.example.org/api/locations?search=title%3D%22Foo%2FBaz%22&per_page=4294967296 response: body: - string: '{"id":8,"name":"New host group","created_at":"2019-12-09T14:28:25.907Z","updated_at":"2019-12-09T14:28:25.907Z","environment_id":null,"operatingsystem_id":null,"architecture_id":null,"medium_id":null,"ptable_id":null,"root_pass":null,"puppet_ca_proxy_id":null,"use_image":null,"image_file":"","ancestry":null,"vm_defaults":null,"subnet_id":null,"domain_id":null,"puppet_proxy_id":null,"title":"New - host group","realm_id":null,"compute_profile_id":null,"content_source_id":null,"grub_pass":"","content_view_id":null,"lifecycle_environment_id":null,"lookup_value_matcher":"hostgroup=New - host group","kickstart_repository_id":null,"subnet6_id":null,"pxe_loader":null,"description":null,"compute_resource_id":null,"openscap_proxy_id":1}' + string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"title=\\\"Foo/Baz\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":\"3\",\"parent_id\":3,\"parent_name\":\"Foo\",\"created_at\":\"2021-03-16 + 17:51:14 UTC\",\"updated_at\":\"2021-03-16 17:51:14 UTC\",\"id\":12,\"name\":\"Baz\",\"title\":\"Foo/Baz\",\"description\":null}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -174,14 +380,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:27 GMT - ETag: - - W/"ef4982856e1dd37e0342606b32d99b23-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -189,15 +391,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9998 - Server: - - Apache - Set-Cookie: - - request_method=DELETE; path=/; secure; HttpOnly; SameSite=Lax - Status: - - 200 OK + - timeout=15, max=94 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -210,17 +406,252 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - ddfb1911-1292-410b-85b6-3f81ffd337cd - X-Runtime: - - '0.053429' X-XSS-Protection: - 1; mode=block content-length: - - '732' + - '360' status: code: 200 message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/locations?search=title%3D%22Bar%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"title=\\\"Bar\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2021-03-16 + 17:51:15 UTC\",\"updated_at\":\"2021-03-16 17:51:15 UTC\",\"id\":13,\"name\":\"Bar\",\"title\":\"Bar\",\"description\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=93 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '355' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/smart_proxies?search=name%3D%22centos7-luna.shu.example.com%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"centos7-luna.shu.example.com\\\"\",\n + \ \"sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": + [{\"created_at\":\"2021-03-16 10:03:09 UTC\",\"updated_at\":\"2021-03-16 10:03:15 + UTC\",\"name\":\"centos7-luna.shu.example.com\",\"id\":1,\"url\":\"https://centos7-luna.shu.example.com:9090\",\"remote_execution_pubkey\":\"ssh-rsa + AAAAB3NzaC1yc2EAAAADAQABAAABAQDR75cBKgge8EKlwZWAPjpdeE3uT/kV7c4NoGWButu5CwiOXV7tri8+af0DUi8wx9VjdPmxxJQDpo8NxA4dnEUlxDBsezKXdRj09da9c/fyI8no4AmcjgYyHpR2UnMLGXuxwVy9+fiLMhzeQWj6Mxp7mVv+73MfsYV+z3UFHW5H25YXiz2njbhG+gWAE8ozWWApt2QFyyKXS40be7sXVYwu6njIaUIoA9J7FxO4gTbT2/IpiPuDFJiotqmkqkQIBQEWco8Amj6OZAjhj9St3OaVSkLLZXv7HugecuQTkhbrFVzOj2rkwonfY8ZpjrdkBWD7cQVC4idKh9CHsmnLYqlZ + foreman-proxy@centos7-luna.shu.example.com\",\"download_policy\":\"on_demand\",\"supported_pulp_types\":{\"pulp2\":{\"supported_types\":[]},\"pulp3\":{\"supported_types\":[\"deb\",\"docker\",\"file\",\"yum\"],\"overriden_to_pulp2\":[]}},\"features\":[{\"capabilities\":[],\"name\":\"Discovery\",\"id\":20},{\"capabilities\":[],\"name\":\"Dynflow\",\"id\":18},{\"capabilities\":[],\"name\":\"Ansible\",\"id\":21},{\"capabilities\":[],\"name\":\"Openscap\",\"id\":22},{\"capabilities\":[],\"name\":\"SSH\",\"id\":19},{\"capabilities\":[\"pulp_certguard\",\"pulp_container\",\"pulp_deb\",\"pulp_file\",\"pulp_rpm\",\"pulpcore\"],\"name\":\"Pulpcore\",\"id\":4},{\"capabilities\":[],\"name\":\"Puppet + CA\",\"id\":10},{\"capabilities\":[],\"name\":\"Puppet\",\"id\":9},{\"capabilities\":[],\"name\":\"Logs\",\"id\":14},{\"capabilities\":[],\"name\":\"Registration\",\"id\":17}]}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=92 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1530' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hostgroups/10/ansible_roles + response: + body: + string: '[{"id":1,"name":"thulium_drake.motd","created_at":"2021-03-16 10:23:34 + UTC","updated_at":"2021-03-16 10:23:34 UTC"}]' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=91 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '116' + status: + code: 200 + message: OK +- request: + body: '{"ansible_role_ids": []}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '24' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/api/hostgroups/10/assign_ansible_roles + response: + body: + string: '{"id":10,"name":"New host group","created_at":"2021-03-16T17:51:22.493Z","updated_at":"2021-03-16T17:51:22.493Z","environment_id":null,"operatingsystem_id":null,"architecture_id":null,"medium_id":null,"ptable_id":null,"root_pass":null,"puppet_ca_proxy_id":null,"use_image":null,"image_file":"","ancestry":null,"vm_defaults":null,"subnet_id":null,"domain_id":null,"puppet_proxy_id":null,"title":"New + host group","realm_id":null,"compute_profile_id":null,"grub_pass":"","lookup_value_matcher":"hostgroup=New + host group","openscap_proxy_id":1,"subnet6_id":null,"pxe_loader":null,"description":null,"compute_resource_id":null}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=90 + Location: + - https://centos7-luna/hostgroups/10-New%20host%20group + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created version: 1 diff --git a/tests/test_playbooks/fixtures/luna_hostgroup-3.yml b/tests/test_playbooks/fixtures/luna_hostgroup-3.yml index 8732362d..f86f3d07 100644 --- a/tests/test_playbooks/fixtures/luna_hostgroup-3.yml +++ b/tests/test_playbooks/fixtures/luna_hostgroup-3.yml @@ -11,27 +11,21 @@ interactions: User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/status + uri: https://foreman.example.org/api/status response: body: - string: '{"result":"ok","status":200,"version":"1.23.1","api_version":2}' + string: '{"result":"ok","status":200,"version":"2.5.0-develop","api_version":2}' headers: Cache-Control: - max-age=0, private, must-revalidate Connection: - Keep-Alive - Content-Length: - - '63' Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:27 GMT - ETag: - - W/"f26fab35869f9a602399f2f56dc6b2ef" Foreman_api_version: - '2' Foreman_current_location: @@ -39,17 +33,13 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=10000 - Server: - - Apache - Set-Cookie: - - _session_id=1adb71aaae1c9a1f3b18a0245a6fe4cc; path=/; secure; HttpOnly; SameSite=Lax - Status: - - 200 OK + - timeout=15, max=100 Strict-Transport-Security: - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding X-Content-Type-Options: - nosniff X-Download-Options: @@ -58,14 +48,10 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 2652d84b-f032-4376-a3c5-a247d87d7c72 - X-Runtime: - - '0.097978' X-XSS-Protection: - 1; mode=block + content-length: + - '70' status: code: 200 message: OK @@ -78,17 +64,17 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=1adb71aaae1c9a1f3b18a0245a6fe4cc User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 + uri: https://foreman.example.org/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 response: body: - string: "{\n \"total\": 0,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\": + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": 4294967296,\n \"search\": \"title=\\\"New host group\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": []\n}\n" + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"subnet_id\":null,\"subnet_name\":null,\"operatingsystem_id\":null,\"operatingsystem_name\":null,\"domain_id\":null,\"domain_name\":null,\"environment_id\":null,\"environment_name\":null,\"compute_profile_id\":null,\"compute_profile_name\":null,\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"ptable_id\":null,\"ptable_name\":null,\"medium_id\":null,\"medium_name\":null,\"pxe_loader\":null,\"subnet6_id\":null,\"subnet6_name\":null,\"compute_resource_id\":null,\"compute_resource_name\":null,\"architecture_id\":null,\"architecture_name\":null,\"realm_id\":null,\"realm_name\":null,\"created_at\":\"2021-03-16 + 17:51:22 UTC\",\"updated_at\":\"2021-03-16 17:51:22 UTC\",\"id\":10,\"name\":\"New + host group\",\"title\":\"New host group\",\"description\":null,\"puppet_proxy_id\":null,\"puppet_proxy_name\":null,\"puppet_ca_proxy_id\":null,\"puppet_ca_proxy_name\":null,\"openscap_proxy_id\":1,\"openscap_proxy_name\":\"centos7-luna.shu.example.com\",\"puppet_proxy\":null,\"puppet_ca_proxy\":null,\"openscap_proxy\":{\"name\":\"centos7-luna.shu.example.com\",\"id\":1,\"url\":\"https://centos7-luna.shu.example.com:9090\"},\"inherited_compute_profile_id\":null,\"inherited_environment_id\":null,\"inherited_domain_id\":null,\"inherited_puppet_proxy_id\":null,\"inherited_puppet_ca_proxy_id\":null,\"inherited_compute_resource_id\":null,\"inherited_operatingsystem_id\":null,\"inherited_architecture_id\":null,\"inherited_medium_id\":null,\"inherited_ptable_id\":null,\"inherited_subnet_id\":null,\"inherited_subnet6_id\":null,\"inherited_realm_id\":null,\"inherited_pxe_loader\":null}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -96,14 +82,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:27 GMT - ETag: - - W/"396d8c1d0d394fdd698ebcb071369922-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -111,13 +93,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9999 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=99 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -130,16 +108,10 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - 1e4ac1c2-d94c-4b13-8cfe-5bcb5ebf1dab - X-Runtime: - - '0.015445' X-XSS-Protection: - 1; mode=block content-length: - - '181' + - '1647' status: code: 200 message: OK @@ -152,17 +124,377 @@ interactions: - gzip, deflate Connection: - keep-alive - Cookie: - - _session_id=1adb71aaae1c9a1f3b18a0245a6fe4cc User-Agent: - apypie (https://github.com/Apipie/apypie) method: GET - uri: https://katello.example.com/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 + uri: https://foreman.example.org/api/hostgroups/10 response: body: - string: "{\n \"total\": 0,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\": - 4294967296,\n \"search\": \"title=\\\"New host group\\\"\",\n \"sort\": - {\n \"by\": null,\n \"order\": null\n },\n \"results\": []\n}\n" + string: '{"content_source_id":null,"content_source_name":null,"content_view_id":null,"content_view_name":null,"lifecycle_environment_id":null,"lifecycle_environment_name":null,"kickstart_repository_id":null,"subnet_id":null,"subnet_name":null,"operatingsystem_id":null,"operatingsystem_name":null,"domain_id":null,"domain_name":null,"environment_id":null,"environment_name":null,"compute_profile_id":null,"compute_profile_name":null,"ancestry":null,"parent_id":null,"parent_name":null,"ptable_id":null,"ptable_name":null,"medium_id":null,"medium_name":null,"pxe_loader":null,"subnet6_id":null,"subnet6_name":null,"compute_resource_id":null,"compute_resource_name":null,"architecture_id":null,"architecture_name":null,"realm_id":null,"realm_name":null,"created_at":"2021-03-16 + 17:51:22 UTC","updated_at":"2021-03-16 17:51:22 UTC","id":10,"name":"New host + group","title":"New host group","description":null,"puppet_proxy_id":null,"puppet_proxy_name":null,"puppet_ca_proxy_id":null,"puppet_ca_proxy_name":null,"openscap_proxy_id":1,"openscap_proxy_name":"centos7-luna.shu.example.com","puppet_proxy":null,"puppet_ca_proxy":null,"openscap_proxy":{"name":"centos7-luna.shu.example.com","id":1,"url":"https://centos7-luna.shu.example.com:9090"},"inherited_compute_profile_id":null,"inherited_environment_id":null,"inherited_domain_id":null,"inherited_puppet_proxy_id":null,"inherited_puppet_ca_proxy_id":null,"inherited_compute_resource_id":null,"inherited_operatingsystem_id":null,"inherited_architecture_id":null,"inherited_medium_id":null,"inherited_ptable_id":null,"inherited_subnet_id":null,"inherited_subnet6_id":null,"inherited_realm_id":null,"inherited_pxe_loader":null,"parameters":[],"template_combinations":[],"puppetclasses":[],"config_groups":[],"all_puppetclasses":[],"locations":[{"id":13,"name":"Bar","title":"Bar","description":null},{"id":3,"name":"Foo","title":"Foo","description":null},{"id":12,"name":"Baz","title":"Foo/Baz","description":null}],"organizations":[{"id":14,"name":"Test + Org1","title":"Test Org1","description":"A test organization"},{"id":15,"name":"Test + Org2","title":"Test Org2","description":"A test organization"}]}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '2140' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Org1%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 3,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Org1\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org1\",\"created_at\":\"2021-03-16 + 17:51:17 UTC\",\"updated_at\":\"2021-03-16 17:51:17 UTC\",\"id\":14,\"name\":\"Test + Org1\",\"title\":\"Test Org1\",\"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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '357' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Org2%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 3,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Org2\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Org2\",\"created_at\":\"2021-03-16 + 17:51:19 UTC\",\"updated_at\":\"2021-03-16 17:51:19 UTC\",\"id\":15,\"name\":\"Test + Org2\",\"title\":\"Test Org2\",\"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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '357' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/locations?search=title%3D%22Foo%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"title=\\\"Foo\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2021-03-16 + 10:51:22 UTC\",\"updated_at\":\"2021-03-16 10:51:22 UTC\",\"id\":3,\"name\":\"Foo\",\"title\":\"Foo\",\"description\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '354' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/locations?search=title%3D%22Foo%2FBaz%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"title=\\\"Foo/Baz\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":\"3\",\"parent_id\":3,\"parent_name\":\"Foo\",\"created_at\":\"2021-03-16 + 17:51:14 UTC\",\"updated_at\":\"2021-03-16 17:51:14 UTC\",\"id\":12,\"name\":\"Baz\",\"title\":\"Foo/Baz\",\"description\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=94 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '360' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/locations?search=title%3D%22Bar%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 4,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"title=\\\"Bar\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"created_at\":\"2021-03-16 + 17:51:15 UTC\",\"updated_at\":\"2021-03-16 17:51:15 UTC\",\"id\":13,\"name\":\"Bar\",\"title\":\"Bar\",\"description\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=93 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '355' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/smart_proxies?search=name%3D%22centos7-luna.shu.example.com%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"centos7-luna.shu.example.com\\\"\",\n + \ \"sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": + [{\"created_at\":\"2021-03-16 10:03:09 UTC\",\"updated_at\":\"2021-03-16 10:03:15 + UTC\",\"name\":\"centos7-luna.shu.example.com\",\"id\":1,\"url\":\"https://centos7-luna.shu.example.com:9090\",\"remote_execution_pubkey\":\"ssh-rsa + AAAAB3NzaC1yc2EAAAADAQABAAABAQDR75cBKgge8EKlwZWAPjpdeE3uT/kV7c4NoGWButu5CwiOXV7tri8+af0DUi8wx9VjdPmxxJQDpo8NxA4dnEUlxDBsezKXdRj09da9c/fyI8no4AmcjgYyHpR2UnMLGXuxwVy9+fiLMhzeQWj6Mxp7mVv+73MfsYV+z3UFHW5H25YXiz2njbhG+gWAE8ozWWApt2QFyyKXS40be7sXVYwu6njIaUIoA9J7FxO4gTbT2/IpiPuDFJiotqmkqkQIBQEWco8Amj6OZAjhj9St3OaVSkLLZXv7HugecuQTkhbrFVzOj2rkwonfY8ZpjrdkBWD7cQVC4idKh9CHsmnLYqlZ + foreman-proxy@centos7-luna.shu.example.com\",\"download_policy\":\"on_demand\",\"supported_pulp_types\":{\"pulp2\":{\"supported_types\":[]},\"pulp3\":{\"supported_types\":[\"deb\",\"docker\",\"file\",\"yum\"],\"overriden_to_pulp2\":[]}},\"features\":[{\"capabilities\":[],\"name\":\"Discovery\",\"id\":20},{\"capabilities\":[],\"name\":\"Dynflow\",\"id\":18},{\"capabilities\":[],\"name\":\"Ansible\",\"id\":21},{\"capabilities\":[],\"name\":\"Openscap\",\"id\":22},{\"capabilities\":[],\"name\":\"SSH\",\"id\":19},{\"capabilities\":[\"pulp_certguard\",\"pulp_container\",\"pulp_deb\",\"pulp_file\",\"pulp_rpm\",\"pulpcore\"],\"name\":\"Pulpcore\",\"id\":4},{\"capabilities\":[],\"name\":\"Puppet + CA\",\"id\":10},{\"capabilities\":[],\"name\":\"Puppet\",\"id\":9},{\"capabilities\":[],\"name\":\"Logs\",\"id\":14},{\"capabilities\":[],\"name\":\"Registration\",\"id\":17}]}]\n}\n" headers: Cache-Control: - max-age=0, private, must-revalidate @@ -170,14 +502,10 @@ interactions: - Keep-Alive Content-Security-Policy: - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; - img-src ''self'' data: *.gravatar.com; script-src ''unsafe-eval'' ''unsafe-inline'' - ''self''; style-src ''unsafe-inline'' ''self''' + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' Content-Type: - application/json; charset=utf-8 - Date: - - Mon, 09 Dec 2019 14:28:27 GMT - ETag: - - W/"396d8c1d0d394fdd698ebcb071369922-gzip" Foreman_api_version: - '2' Foreman_current_location: @@ -185,13 +513,9 @@ interactions: Foreman_current_organization: - ; ANY Foreman_version: - - 1.23.1 + - 2.5.0-develop Keep-Alive: - - timeout=5, max=9998 - Server: - - Apache - Status: - - 200 OK + - timeout=15, max=92 Strict-Transport-Security: - max-age=631139040; includeSubdomains Vary: @@ -204,16 +528,66 @@ interactions: - sameorigin X-Permitted-Cross-Domain-Policies: - none - X-Powered-By: - - Phusion Passenger 4.0.53 - X-Request-Id: - - d33c16a6-603e-41f6-a9c2-96c001da895d - X-Runtime: - - '0.015153' X-XSS-Protection: - 1; mode=block content-length: - - '181' + - '1530' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hostgroups/10/ansible_roles + response: + body: + string: '[]' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=91 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '2' status: code: 200 message: OK diff --git a/tests/test_playbooks/fixtures/luna_hostgroup-4.yml b/tests/test_playbooks/fixtures/luna_hostgroup-4.yml new file mode 100644 index 00000000..b71e17dc --- /dev/null +++ b/tests/test_playbooks/fixtures/luna_hostgroup-4.yml @@ -0,0 +1,178 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"title=\\\"New host group\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"subnet_id\":null,\"subnet_name\":null,\"operatingsystem_id\":null,\"operatingsystem_name\":null,\"domain_id\":null,\"domain_name\":null,\"environment_id\":null,\"environment_name\":null,\"compute_profile_id\":null,\"compute_profile_name\":null,\"ancestry\":null,\"parent_id\":null,\"parent_name\":null,\"ptable_id\":null,\"ptable_name\":null,\"medium_id\":null,\"medium_name\":null,\"pxe_loader\":null,\"subnet6_id\":null,\"subnet6_name\":null,\"compute_resource_id\":null,\"compute_resource_name\":null,\"architecture_id\":null,\"architecture_name\":null,\"realm_id\":null,\"realm_name\":null,\"created_at\":\"2021-03-16 + 17:51:22 UTC\",\"updated_at\":\"2021-03-16 17:51:22 UTC\",\"id\":10,\"name\":\"New + host group\",\"title\":\"New host group\",\"description\":null,\"puppet_proxy_id\":null,\"puppet_proxy_name\":null,\"puppet_ca_proxy_id\":null,\"puppet_ca_proxy_name\":null,\"openscap_proxy_id\":1,\"openscap_proxy_name\":\"centos7-luna.shu.example.com\",\"puppet_proxy\":null,\"puppet_ca_proxy\":null,\"openscap_proxy\":{\"name\":\"centos7-luna.shu.example.com\",\"id\":1,\"url\":\"https://centos7-luna.shu.example.com:9090\"},\"inherited_compute_profile_id\":null,\"inherited_environment_id\":null,\"inherited_domain_id\":null,\"inherited_puppet_proxy_id\":null,\"inherited_puppet_ca_proxy_id\":null,\"inherited_compute_resource_id\":null,\"inherited_operatingsystem_id\":null,\"inherited_architecture_id\":null,\"inherited_medium_id\":null,\"inherited_ptable_id\":null,\"inherited_subnet_id\":null,\"inherited_subnet6_id\":null,\"inherited_realm_id\":null,\"inherited_pxe_loader\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1647' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '0' + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: DELETE + uri: https://foreman.example.org/api/hostgroups/10 + response: + body: + string: '{"id":10,"name":"New host group","created_at":"2021-03-16T17:51:22.493Z","updated_at":"2021-03-16T17:51:22.493Z","environment_id":null,"operatingsystem_id":null,"architecture_id":null,"medium_id":null,"ptable_id":null,"root_pass":null,"puppet_ca_proxy_id":null,"use_image":null,"image_file":"","ancestry":null,"vm_defaults":null,"subnet_id":null,"domain_id":null,"puppet_proxy_id":null,"title":"New + host group","realm_id":null,"compute_profile_id":null,"grub_pass":"","lookup_value_matcher":"hostgroup=New + host group","openscap_proxy_id":1,"subnet6_id":null,"pxe_loader":null,"description":null,"compute_resource_id":null}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '622' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/luna_hostgroup-5.yml b/tests/test_playbooks/fixtures/luna_hostgroup-5.yml new file mode 100644 index 00000000..424569ee --- /dev/null +++ b/tests/test_playbooks/fixtures/luna_hostgroup-5.yml @@ -0,0 +1,116 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hostgroups?search=title%3D%22New+host+group%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 0,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"title=\\\"New host group\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": []\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '181' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/luna_hostgroup.yml b/tests/test_playbooks/luna_hostgroup.yml index df920566..f4d596d8 100644 --- a/tests/test_playbooks/luna_hostgroup.yml +++ b/tests/test_playbooks/luna_hostgroup.yml @@ -1,3 +1,4 @@ +# `ansible-galaxy role install thulium_drake.motd -p /usr/share/ansible/roles` --- - hosts: localhost collections: @@ -35,6 +36,8 @@ hostgroup_locations: "{{ hostgroup.locations }}" hostgroup_organizations: "{{ hostgroup.organizations }}" hostgroup_openscap_proxy: "{{ hostgroup.openscap_proxy }}" + hostgroup_ansible_roles: + - thulium_drake.motd hostgroup_state: present expected_change: true @@ -44,6 +47,28 @@ hostgroup_locations: "{{ hostgroup.locations }}" hostgroup_organizations: "{{ hostgroup.organizations }}" hostgroup_openscap_proxy: "{{ hostgroup.openscap_proxy }}" + hostgroup_ansible_roles: + - thulium_drake.motd + hostgroup_state: present + expected_change: false + + - include: tasks/hostgroup.yml + vars: + hostgroup_name: "New host group" + hostgroup_locations: "{{ hostgroup.locations }}" + hostgroup_organizations: "{{ hostgroup.organizations }}" + hostgroup_openscap_proxy: "{{ hostgroup.openscap_proxy }}" + hostgroup_ansible_roles: [] + hostgroup_state: present + expected_change: true + + - include: tasks/hostgroup.yml + vars: + hostgroup_name: "New host group" + hostgroup_locations: "{{ hostgroup.locations }}" + hostgroup_organizations: "{{ hostgroup.organizations }}" + hostgroup_openscap_proxy: "{{ hostgroup.openscap_proxy }}" + hostgroup_ansible_roles: [] hostgroup_state: present expected_change: false diff --git a/tests/test_playbooks/tasks/hostgroup.yml b/tests/test_playbooks/tasks/hostgroup.yml index a0e675f5..b17220d3 100644 --- a/tests/test_playbooks/tasks/hostgroup.yml +++ b/tests/test_playbooks/tasks/hostgroup.yml @@ -36,6 +36,7 @@ content_source: "{{ hostgroup_content_source | default(omit) }}" lifecycle_environment: "{{ hostgroup_lifecycle_environment | default(omit) }}" content_view: "{{ hostgroup_content_view | default(omit) }}" + ansible_roles: "{{ hostgroup_ansible_roles | default(omit) }}" parameters: "{{ hostgroup_parameters | default(omit) }}" state: "{{ hostgroup_state }}" register: result From 2045c5edef5792d3235eb5c2b234ef08e3fa96b3 Mon Sep 17 00:00:00 2001 From: William Bradford Clark Date: Mon, 22 Mar 2021 06:51:51 -0400 Subject: [PATCH 14/56] Add a role to perform basic setup to register and patch RHEL clients (#1135) * Add a role to perform basic setup to register and patch RHEL clients * Don't match against manifest in content_rhel_role fixture * Record test fixtures * Add changelog fragment for content_rhel role * Skip check_mode tests for content_rhel_role content_rhel_role uses async tasks, which are unsupported by check_mode * Trim extraneous requests from test fixtures The fixtures contain a lot of requests checking on the status of a Foreman task which is in state running/pending. We can minimize the diff and speed up execution by eliminating redundant requests/responses after the first one. --- .../fragments/1097-content-rhel-role.yml | 2 + roles/content_rhel/README.md | 123 +++++ roles/content_rhel/defaults/main.yml | 5 + roles/content_rhel/tasks/main.yml | 94 ++++ tests/fixtures/apidoc/content_rhel_role.json | 1 + tests/test_crud.py | 2 +- tests/test_playbooks/content_rhel_role.yml | 32 ++ .../fixtures/content_rhel_role-0.yml | 460 ++++++++++++++++++ .../fixtures/content_rhel_role-1.yml | 452 +++++++++++++++++ .../fixtures/content_rhel_role-2.yml | 440 +++++++++++++++++ .../fixtures/content_rhel_role-3.yml | 441 +++++++++++++++++ .../fixtures/content_rhel_role-5.yml | 371 ++++++++++++++ .../fixtures/content_rhel_role-7.yml | 371 ++++++++++++++ .../fixtures/content_rhel_role-8.yml | 433 +++++++++++++++++ .../fixtures/content_rhel_role-9.yml | 367 ++++++++++++++ tests/vcr_python_wrapper.py | 2 +- 16 files changed, 3594 insertions(+), 2 deletions(-) create mode 100644 changelogs/fragments/1097-content-rhel-role.yml create mode 100644 roles/content_rhel/README.md create mode 100644 roles/content_rhel/defaults/main.yml create mode 100644 roles/content_rhel/tasks/main.yml create mode 120000 tests/fixtures/apidoc/content_rhel_role.json create mode 100644 tests/test_playbooks/content_rhel_role.yml create mode 100644 tests/test_playbooks/fixtures/content_rhel_role-0.yml create mode 100644 tests/test_playbooks/fixtures/content_rhel_role-1.yml create mode 100644 tests/test_playbooks/fixtures/content_rhel_role-2.yml create mode 100644 tests/test_playbooks/fixtures/content_rhel_role-3.yml create mode 100644 tests/test_playbooks/fixtures/content_rhel_role-5.yml create mode 100644 tests/test_playbooks/fixtures/content_rhel_role-7.yml create mode 100644 tests/test_playbooks/fixtures/content_rhel_role-8.yml create mode 100644 tests/test_playbooks/fixtures/content_rhel_role-9.yml diff --git a/changelogs/fragments/1097-content-rhel-role.yml b/changelogs/fragments/1097-content-rhel-role.yml new file mode 100644 index 00000000..b2ecfd3a --- /dev/null +++ b/changelogs/fragments/1097-content-rhel-role.yml @@ -0,0 +1,2 @@ +minor_changes: + - Add a role `content_rhel` to perform basic setup for registering and syncing RHEL content hosts diff --git a/roles/content_rhel/README.md b/roles/content_rhel/README.md new file mode 100644 index 00000000..f10a20b1 --- /dev/null +++ b/roles/content_rhel/README.md @@ -0,0 +1,123 @@ +theforeman.foreman.content_rhel +=============================== + +This role is an opinionated reuse of other roles in the collection, which creates a basic configuration for everything needed to register and patch existing RHEL clients. + +That includes uploading a subscription manifest to an organization; enabling base RHEL7 and RHEL8 repositories (x86_64 architecture), syncing them immediately, and creating a sync plan for future syncs; and creating an activation key `base_rhel_key` to use when registering RHEL clients. + +The subscription manifest will be retrieved from the specified path on the Ansible target host; optionally, it can be fetched first from the RHSM portal using the provided login credentials and manifest UUID. It will be uploaded to the specified organization. + +By default, the role enables the rhel-7-server-rpms repository with the 7Server release and x86_64 architecture, as well as rhel-8-for-x86_64-baseos-rpms and rhel-8-for-x86_64-appstream-rpms. The manifest must provide access to all enabled content for the role to work properly. + +The role creates a sync plan using any of the sync plan intervals supported by the basic [Sync Plan Role](https://github.com/theforeman/foreman-ansible-modules/blob/develop/roles/sync_plans/README.md). + +The role creates an activation key with the provided name. This activation key will register client systems in the "Library" lifecycle environment and "Default Organization View" content view, using the subscription auto-attach feature. + +Role Variables +-------------- + +This role supports the [Common Role Variables](https://github.com/theforeman/foreman-ansible-modules/blob/develop/README.md#common-role-variables). + +This role supports the same variables used in the [Manifest Role](https://github.com/theforeman/foreman-ansible-modules/blob/develop/roles/manifest/README.md#role-variables). + +It also supports customizing the included roles with: + +`foreman_sync_plan_name`: Name of the sync plan to create. Default 'RHEL Sync Plan' + +`foreman_sync_plan_interval`: 'hourly', 'daily', 'weekly', or 'custom cron'. See the [Sync Plan Role Documentation](https://github.com/theforeman/foreman-ansible-modules/blob/develop/roles/manifest/README.md#role-variables) for more information. Default 'daily' + +`foreman_sync_plan_cron_expression`: Required when using the 'custom cron' `sync_plan_interval`. + +`foreman_sync_plan_sync_date`: Initial sync date for the sync plan, formatted as 'YYYY-MM-DD HH:MM:SS UTC'. + +`foreman_activation_key_name`: Name of the activation key to create. Default 'base_rhel_key' + +Repository behavior is controlled via the variables: + +`foreman_content_rhel_enable_rhel7`: Enable rhel-7-server-rpms repository (x86 architecture and 7Server release). Default true. + +`foreman_content_rhel_enable_rhel8`: Enable rhel-8-for-x86_64-baseos-rpms and rhel-8-for-x86_64-appstream-rpms (x86 architecture). Default true. + +`foreman_content_rhel_sync_now`: Sync repositories immediately after enabling. Default true. + +`foreman_content_rhel_wait_for_syncs`: Monitor status of sync tasks. When false, the sync tasks will continue running in the background after the playbook has finished running. This option is most useful when other automation (for example, registering and patching a client) requires the repository syncs to have completed. Default true. + +Example Playbooks +----------------- + +This minimal example assumes the manifest has already been downloaded to ~/manifest.zip on localhost (the Ansible control node) and uploads that manifest to the ACME organization. It enables RHEL7 and RHEL8 repositories, creates the role default sync plan for them, and also syncs the repositories immediately. It creates an activation key with the role default name `base_rhel_key`. + +```yaml +- hosts: localhost + roles: + - role: theforeman.foreman.content_rhel + vars: + foreman_server_url: https://foreman.example.com + foreman_username: "admin" + foreman_password: "changeme" + foreman_organization: "ACME" + foreman_manifest_download: False + foreman_manifest_path: "~/manifest.zip" +``` + +This example is identical to the above example, except instead of assuming the manifest is already downloaded at ~/manifest.zip, we first use the provided rhsm_{username,password} and manifest_uuid to download it from the Red Hat Customer Portal. + +```yaml +- hosts: localhost + roles: + - role: theforeman.foreman.content_rhel + vars: + foreman_server_url: https://foreman.example.com + foreman_username: "admin" + foreman_password: "changeme" + foreman_organization: "ACME" + foreman_manifest_download: True + foreman_rhsm_username: "happycustomer" + foreman_rhsm_password: "$ecur3p4$$w0rd" + foreman_manifest_uuid: "01234567-89ab-cdef-0123-456789abcdef" + foreman_manifest_path: "~/manifest.zip" +``` + +This example downloads a manifest with the provided UUID from the RHSM portal using the provided credentials and copies it to ~/manifest.zip before uploading it to "Default Organization". It then enables the RHEL7 and RHEL8 repositories without syncing them immediately, but creates a sync_plan which syncs the repositories at midnight each day. It creates an activation key "RHEL_Key" to register existing RHEL content hosts. + +```yaml +- hosts: localhost + roles: + - role: theforeman.foreman.content_rhel + vars: + foreman_server_url: https://foreman.example.com + foreman_username: "admin" + foreman_password: "changeme" + foreman_organization: "Default Organization" + foreman_manifest_download: True + foreman_rhsm_username: "happycustomer" + foreman_rhsm_password: "$ecur3p4$$w0rd" + foreman_manifest_uuid: "01234567-89ab-cdef-0123-456789abcdef" + foreman_manifest_path: "~/manifest.zip" + foreman_content_rhel_sync_now: false + foreman_sync_plan_name: "Daily RHEL Sync" + foreman_sync_plan_interval: daily + foreman_sync_plan_sync_date: 2021-02-02 00:00:00 UTC + foreman_activation_key_name: "RHEL_Key" +``` + +This example assumes the manifest has already been downloaded to ~/my_subscription_manifesst.zip on localhost and uploads that manifest to the ACME organization. It enables the rhel-7-server-rpms repository only, syncs it immediately, and also creates a custom cron sync plan for it. It creates an activation key "RHEL_Key" to register existing RHEL content hosts. + +```yaml +- hosts: localhost + roles: + - role: theforeman.foreman.content_rhel + vars: + foreman_server_url: https://foreman.example.com + foreman_username: "admin" + foreman_password: "changeme" + foreman_organization: "ACME" + foreman_manifest_download: False + foreman_manifest_path: "~/my_subscription_manifest.zip" + foreman_content_rhel_enable_rhel8: false + foreman_sync_plan_name: "RHEL Sync Plan" + foreman_sync_plan_interval: custom cron + foreman_sync_plan_cron_expression: 0 6 8 * * + foreman_sync_plan_sync_date: 2021-02-02 00:00:00 UTC + foreman_activation_key_name: "RHEL_Key" +``` diff --git a/roles/content_rhel/defaults/main.yml b/roles/content_rhel/defaults/main.yml new file mode 100644 index 00000000..05d1b004 --- /dev/null +++ b/roles/content_rhel/defaults/main.yml @@ -0,0 +1,5 @@ +--- +foreman_content_rhel_enable_rhel7: true +foreman_content_rhel_enable_rhel8: true +foreman_content_rhel_sync_now: true +foreman_content_rhel_wait_for_syncs: true diff --git a/roles/content_rhel/tasks/main.yml b/roles/content_rhel/tasks/main.yml new file mode 100644 index 00000000..79d7a2bf --- /dev/null +++ b/roles/content_rhel/tasks/main.yml @@ -0,0 +1,94 @@ +--- +- name: "Subscription Manifest" + include_role: + name: theforeman.foreman.manifest + +- name: "Enable RHEL7 repository" + include_role: + name: theforeman.foreman.repositories + vars: + foreman_products: + - name: Red Hat Enterprise Linux Server + repository_sets: + - name: Red Hat Enterprise Linux 7 Server (RPMs) + basearch: x86_64 + releasever: 7Server + when: foreman_content_rhel_enable_rhel7 + +- name: "Enable RHEL8 repositories" + include_role: + name: theforeman.foreman.repositories + vars: + foreman_products: + - name: Red Hat Enterprise Linux for x86_64 + repository_sets: + - name: Red Hat Enterprise Linux 8 for x86_64 - BaseOS (RPMs) + releasever: 8 + - name: Red Hat Enterprise Linux 8 for x86_64 - AppStream (RPMs) + releasever: 8 + when: foreman_content_rhel_enable_rhel8 + +- name: "Sync RHEL7 repository" + theforeman.foreman.repository_sync: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + organization: "{{ foreman_organization }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + product: Red Hat Enterprise Linux Server + async: 14400 + poll: 0 + register: rhel7_sync + when: foreman_content_rhel_enable_rhel7 and foreman_content_rhel_sync_now + +- name: "Sync RHEL8 repositories" + theforeman.foreman.repository_sync: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + organization: "{{ foreman_organization }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + product: Red Hat Enterprise Linux for x86_64 + async: 14400 + poll: 0 + register: rhel8_sync + when: foreman_content_rhel_enable_rhel8 and foreman_content_rhel_sync_now + +- name: "Create Sync Plan" + include_role: + name: theforeman.foreman.sync_plans + vars: + foreman_sync_plans: + - name: "{{ foreman_sync_plan_name | default('RHEL Sync Plan') }}" + interval: "{{ foreman_sync_plan_interval | default('daily') }}" + cron_expression: "{{ foreman_sync_plan_cron_expression | default(omit) }}" + sync_date: "{{ foreman_sync_plan_sync_date | default('2020-01-01 00:00:00 UTC') }}" + products: + - Red Hat Enterprise Linux Server + - Red Hat Enterprise Linux for x86_64 + +- name: "Create Activation Key" + include_role: + name: theforeman.foreman.activation_keys + vars: + foreman_activation_keys: + - name: "{{ foreman_activation_key_name | default('base_rhel_key') }}" + description: "Generated by ansible role theforeman.foreman.content_rhel" + +- name: "Wait for RHEL7 sync completion" + async_status: + jid: "{{ rhel7_sync.ansible_job_id }}" + register: rhel7_job_result + until: rhel7_job_result.finished + retries: 99999 + delay: 10 + when: foreman_content_rhel_enable_rhel7 and foreman_content_rhel_sync_now and foreman_content_rhel_wait_for_syncs + +- name: "Wait for RHEL8 sync completion" + async_status: + jid: "{{ rhel8_sync.ansible_job_id }}" + register: rhel8_job_result + until: rhel8_job_result.finished + retries: 99999 + delay: 10 + when: foreman_content_rhel_enable_rhel8 and foreman_content_rhel_sync_now and foreman_content_rhel_wait_for_syncs diff --git a/tests/fixtures/apidoc/content_rhel_role.json b/tests/fixtures/apidoc/content_rhel_role.json new file mode 120000 index 00000000..8e89899a --- /dev/null +++ b/tests/fixtures/apidoc/content_rhel_role.json @@ -0,0 +1 @@ +katello.json \ No newline at end of file diff --git a/tests/test_crud.py b/tests/test_crud.py index a9e4c6d6..0ca29a03 100644 --- a/tests/test_crud.py +++ b/tests/test_crud.py @@ -96,7 +96,7 @@ def test_crud(tmpdir, module, vcrmode): @pytest.mark.parametrize('module', TEST_PLAYBOOKS) def test_check_mode(tmpdir, module): - if module in ['subscription_manifest', 'templates_import', 'puppetclasses_import']: + if module in ['subscription_manifest', 'templates_import', 'puppetclasses_import', 'content_rhel_role']: pytest.skip("This module does not support check_mode.") run = run_playbook_vcr(tmpdir, module, check_mode=True) assert run.rc == 0 diff --git a/tests/test_playbooks/content_rhel_role.yml b/tests/test_playbooks/content_rhel_role.yml new file mode 100644 index 00000000..d42ee46c --- /dev/null +++ b/tests/test_playbooks/content_rhel_role.yml @@ -0,0 +1,32 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: ensure test organization + include_tasks: tasks/organization.yml + vars: + organization_name: "Test Organization" + organization_state: "present" + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + roles: + - role: content_rhel + vars: + foreman_organization: "Test Organization" + foreman_validate_certs: false + foreman_manifest_download: false + foreman_manifest_path: "{{ subscription_manifest_path }}" + foreman_sync_plan_name: "RHEL Sync Plan" + foreman_sync_plan_interval: daily + foreman_sync_plan_sync_date: 2021-02-02 00:00:00 UTC + foreman_activation_key_name: "basic_rhel_key" + foreman_content_rhel_wait_for_syncs: "{{ ansible_version['full'] is version('2.9', '>=') }}" diff --git a/tests/test_playbooks/fixtures/content_rhel_role-0.yml b/tests/test_playbooks/fixtures/content_rhel_role-0.yml new file mode 100644 index 00000000..e269bcde --- /dev/null +++ b/tests/test_playbooks/fixtures/content_rhel_role-0.yml @@ -0,0 +1,460 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-03-18 16:15:36 UTC\",\"updated_at\"\ + :\"2021-03-18 16:15:36 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3 + response: + body: + string: '{"label":"Test_Organization","redhat_repository_url":"https://cdn.redhat.com","system_purposes":{"addons":[],"roles":[],"usage":[],"support_level":[]},"service_levels":[],"service_level":null,"select_all_types":[],"description":"A + test organization","created_at":"2021-03-18 16:15:36 UTC","updated_at":"2021-03-18 + 16:15:36 UTC","ancestry":null,"parent_id":null,"parent_name":null,"id":3,"name":"Test + Organization","title":"Test Organization","users":[],"smart_proxies":[{"name":"wclark-katello.usersys.redhat.com","id":1,"url":"https://wclark-katello.usersys.redhat.com:9090","inherited":false}],"subnets":[],"compute_resources":[],"media":[],"ptables":[{"description":null,"os_family":"Suse","created_at":"2021-03-18 + 16:03:12 UTC","updated_at":"2021-03-18 16:03:12 UTC","name":"AutoYaST entire + SCSI disk","id":110,"inherited":false},{"description":null,"os_family":"Suse","created_at":"2021-03-18 + 16:03:12 UTC","updated_at":"2021-03-18 16:03:12 UTC","name":"AutoYaST entire + virtual disk","id":111,"inherited":false},{"description":null,"os_family":"Suse","created_at":"2021-03-18 + 16:03:12 UTC","updated_at":"2021-03-18 16:03:12 UTC","name":"AutoYaST LVM","id":112,"inherited":false},{"description":null,"os_family":"Coreos","created_at":"2021-03-18 + 16:03:12 UTC","updated_at":"2021-03-18 16:03:12 UTC","name":"CoreOS default + fake","id":113,"inherited":false},{"description":null,"os_family":"Rancheros","created_at":"2021-03-18 + 16:03:12 UTC","updated_at":"2021-03-18 16:03:12 UTC","name":"Empty","id":114,"inherited":false},{"description":null,"os_family":"Freebsd","created_at":"2021-03-18 + 16:03:12 UTC","updated_at":"2021-03-18 16:03:12 UTC","name":"FreeBSD default + fake","id":115,"inherited":false},{"description":null,"os_family":"Solaris","created_at":"2021-03-18 + 16:03:12 UTC","updated_at":"2021-03-18 16:03:12 UTC","name":"Jumpstart default","id":116,"inherited":false},{"description":null,"os_family":"Solaris","created_at":"2021-03-18 + 16:03:12 UTC","updated_at":"2021-03-18 16:03:12 UTC","name":"Jumpstart mirrored","id":117,"inherited":false},{"description":null,"os_family":"Junos","created_at":"2021-03-18 + 16:03:13 UTC","updated_at":"2021-03-18 16:03:13 UTC","name":"Junos default + fake","id":118,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-03-18 + 16:03:13 UTC","updated_at":"2021-03-18 16:03:13 UTC","name":"Kickstart custom","id":119,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-03-18 + 16:03:13 UTC","updated_at":"2021-03-18 16:03:13 UTC","name":"Kickstart default","id":120,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-03-18 + 16:03:13 UTC","updated_at":"2021-03-18 16:03:13 UTC","name":"Kickstart default + thin","id":121,"inherited":false},{"description":null,"os_family":"NXOS","created_at":"2021-03-18 + 16:03:13 UTC","updated_at":"2021-03-18 16:03:13 UTC","name":"NX-OS default + fake","id":122,"inherited":false},{"description":null,"os_family":"Debian","created_at":"2021-03-18 + 16:03:13 UTC","updated_at":"2021-03-18 16:03:13 UTC","name":"Preseed default","id":123,"inherited":false},{"description":null,"os_family":"Debian","created_at":"2021-03-18 + 16:03:13 UTC","updated_at":"2021-03-18 16:03:13 UTC","name":"Preseed default + LVM","id":124,"inherited":false},{"description":null,"os_family":"Windows","created_at":"2021-03-18 + 16:03:13 UTC","updated_at":"2021-03-18 16:03:13 UTC","name":"Windows default + GPT EFI partition table","id":126,"inherited":false},{"description":null,"os_family":"Windows","created_at":"2021-03-18 + 16:03:13 UTC","updated_at":"2021-03-18 16:03:13 UTC","name":"Windows default + partition table","id":125,"inherited":false},{"description":null,"os_family":"Xenserver","created_at":"2021-03-18 + 16:03:13 UTC","updated_at":"2021-03-18 16:03:13 UTC","name":"XenServer default","id":127,"inherited":false}],"provisioning_templates":[{"id":43,"name":"Alterator + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":28,"name":"Alterator + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":10,"name":"Alterator + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":61,"name":"alterator_pkglist","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":62,"name":"ansible_provisioning_callback","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":63,"name":"ansible_tower_callback_script","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":64,"name":"ansible_tower_callback_service","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":44,"name":"Atomic + Kickstart default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":45,"name":"AutoYaST + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":36,"name":"AutoYaST + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":11,"name":"AutoYaST + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":105,"name":"AutoYaST + default user data","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":46,"name":"AutoYaST + SLES default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":65,"name":"blacklist_kernel_modules","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":66,"name":"bmc_nic_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":67,"name":"built","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":68,"name":"chef_client","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":27,"name":"CloudInit + default","template_kind_id":11,"template_kind_name":"cloud-init","inherited":false},{"id":69,"name":"coreos_cloudconfig","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":47,"name":"CoreOS + provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":12,"name":"CoreOS + PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":70,"name":"create_users","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":71,"name":"csr_attributes.yaml","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":72,"name":"efibootmgr_netboot","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":73,"name":"epel","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":74,"name":"fips_packages","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":75,"name":"fix_hosts","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":29,"name":"FreeBSD + (mfsBSD) finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":48,"name":"FreeBSD + (mfsBSD) provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":13,"name":"FreeBSD + (mfsBSD) PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":76,"name":"freeipa_register","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":57,"name":"Global + Registration","template_kind_id":12,"template_kind_name":"registration","inherited":false},{"id":59,"name":"Grubby + default","template_kind_id":7,"template_kind_name":"script","inherited":false},{"id":77,"name":"http_proxy","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":80,"name":"insights","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":37,"name":"iPXE + default local boot","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":38,"name":"iPXE + global default","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":39,"name":"iPXE + intermediate script","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":49,"name":"Jumpstart + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":30,"name":"Jumpstart + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":2,"name":"Jumpstart + default PXEGrub","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":31,"name":"Junos + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":50,"name":"Junos + default SLAX","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":26,"name":"Junos + default ZTP config","template_kind_id":9,"template_kind_name":"ZTP","inherited":false},{"id":51,"name":"Kickstart + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":32,"name":"Kickstart + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":40,"name":"Kickstart + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":3,"name":"Kickstart + default PXEGrub","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":6,"name":"Kickstart + default PXEGrub2","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":14,"name":"Kickstart + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":106,"name":"Kickstart + default user data","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":79,"name":"kickstart_ifcfg_bonded_interface","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":78,"name":"kickstart_ifcfg_bond_interface","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":81,"name":"kickstart_ifcfg_generic_interface","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":83,"name":"kickstart_ifcfg_get_identifier_names","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":84,"name":"kickstart_kernel_options","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":85,"name":"kickstart_networking_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":52,"name":"Kickstart + oVirt-RHVH","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":15,"name":"Kickstart + oVirt-RHVH PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":58,"name":"Linux + registration default","template_kind_id":12,"template_kind_name":"registration","inherited":false},{"id":86,"name":"ntp","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":1,"name":"NX-OS + default POAP setup","template_kind_id":10,"template_kind_name":"POAP","inherited":false},{"id":53,"name":"Preseed + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":33,"name":"Preseed + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":41,"name":"Preseed + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":7,"name":"Preseed + default PXEGrub2","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":16,"name":"Preseed + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":107,"name":"Preseed + default user data","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":87,"name":"preseed_networking_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":88,"name":"puppet.conf","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":90,"name":"puppetlabs_repo","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":89,"name":"puppet_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":91,"name":"pxegrub2_chainload","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":8,"name":"PXEGrub2 + default local boot","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":92,"name":"pxegrub2_discovery","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":9,"name":"PXEGrub2 + global default","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":93,"name":"pxegrub2_mac","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":94,"name":"pxegrub_chainload","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":4,"name":"PXEGrub + default local boot","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":95,"name":"pxegrub_discovery","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":5,"name":"PXEGrub + global default","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":17,"name":"PXELinux + chain iPXE","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":18,"name":"PXELinux + chain iPXE UNDI","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":96,"name":"pxelinux_chainload","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":19,"name":"PXELinux + default local boot","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":20,"name":"PXELinux + default memdisk","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":97,"name":"pxelinux_discovery","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":21,"name":"PXELinux + global default","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":98,"name":"rancheros_cloudconfig","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":54,"name":"RancherOS + provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":22,"name":"RancherOS + PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":99,"name":"redhat_register","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":100,"name":"remote_execution_ssh_keys","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":101,"name":"saltstack_minion","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":102,"name":"saltstack_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":82,"name":"schedule_reboot","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":108,"name":"UserData + default","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":109,"name":"UserData + open-vm-tools","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":23,"name":"WAIK + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":34,"name":"Windows + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":42,"name":"Windows + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":55,"name":"Windows + default provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":24,"name":"Windows + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":103,"name":"Windows + network","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":60,"name":"Windows + peSetup.cmd","template_kind_id":7,"template_kind_name":"script","inherited":false},{"id":56,"name":"XenServer + default answerfile","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":35,"name":"XenServer + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":25,"name":"XenServer + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":104,"name":"yum_proxy","template_kind_id":null,"template_kind_name":null,"inherited":false}],"domains":[],"realms":[],"environments":[],"hostgroups":[],"locations":[{"id":2,"name":"Default + Location","title":"Default Location","description":null}],"hosts_count":0,"parameters":[],"simple_content_access":false,"owner_details":{"id":"8a889d597846119d0178461eff130005","key":"Test_Organization","created":"2021-03-18T16:15:39+0000","updated":"2021-03-18T16:15:39+0000","lastRefreshed":null,"virt_who":false,"upstreamConsumer":null},"default_content_view_id":2,"library_id":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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '16329' + status: + code: 200 + message: OK +- request: + body: FAKE_MANIFEST + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '743113' + Content-Type: + - multipart/form-data; boundary=205f77d680b6eec60262c5b815c79437 + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/organizations/3/subscriptions/upload + response: + body: + string: ' {"id":"b8baa7d6-c0d9-48ae-ae86-65d835679ab0","label":"Actions::Katello::Organization::ManifestImport","pending":true,"action":"Import + Manifest organization ''Test Organization''","username":"admin","started_at":"2021-03-18 + 16:15:45 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["candlepin","candlepin_auth"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":3,"current_location_id":null},"output":{},"humanized":{"action":"Import + Manifest","input":[["organization",{"text":"organization ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:15:45 UTC","available_actions":{"cancellable":false,"resumable":false}} + + ' + headers: + Cache-Control: + - 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: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 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/b8baa7d6-c0d9-48ae-ae86-65d835679ab0 + response: + body: + string: '{"id":"b8baa7d6-c0d9-48ae-ae86-65d835679ab0","label":"Actions::Katello::Organization::ManifestImport","pending":true,"action":"Import + Manifest organization ''Test Organization''","username":"admin","started_at":"2021-03-18 + 16:15:45 UTC","ended_at":null,"state":"running","result":"pending","progress":0.0,"input":{"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["candlepin","candlepin_auth"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":3,"current_location_id":null},"output":{},"humanized":{"action":"Import + Manifest","input":[["organization",{"text":"organization ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:15:45 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '910' + 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/foreman_tasks/api/tasks/b8baa7d6-c0d9-48ae-ae86-65d835679ab0 + response: + body: + string: '{"id":"b8baa7d6-c0d9-48ae-ae86-65d835679ab0","label":"Actions::Katello::Organization::ManifestImport","pending":false,"action":"Import + Manifest organization ''Test Organization''","username":"admin","started_at":"2021-03-18 + 16:15:45 UTC","ended_at":"2021-03-18 16:16:30 UTC","state":"stopped","result":"success","progress":1.0,"input":{"organization":{"id":3,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["candlepin","candlepin_auth"],"remote_user":"admin","remote_cp_user":"admin","current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":3,"current_location_id":null},"output":{},"humanized":{"action":"Import + Manifest","input":[["organization",{"text":"organization ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:15:45 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=86 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '932' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/content_rhel_role-1.yml b/tests/test_playbooks/fixtures/content_rhel_role-1.yml new file mode 100644 index 00000000..c06ad6fe --- /dev/null +++ b/tests/test_playbooks/fixtures/content_rhel_role-1.yml @@ -0,0 +1,452 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-03-18 16:15:36 UTC\",\"updated_at\"\ + :\"2021-03-18 16:16:30 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Red+Hat+Enterprise+Linux+Server%22&per_page=4294967296 + response: + body: + string: '{"total":289,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux Server\"","sort":{"by":"name","order":"asc"},"results":[{"id":126,"cp_id":"69","name":"Red + Hat Enterprise Linux Server","label":"Red_Hat_Enterprise_Linux_Server","description":null,"provider_id":4,"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":0}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '638' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/126/repository_sets?organization_id=3&search=name%3D%22Red+Hat+Enterprise+Linux+7+Server+%28RPMs%29%22&per_page=4294967296 + response: + body: + string: '{"total":392,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux 7 Server (RPMs)\"","sort":{"by":"name","order":"asc"},"results":[{"enabled":true,"product":{"id":126,"name":"Red + Hat Enterprise Linux Server"},"repositories":[],"name":"Red Hat Enterprise + Linux 7 Server (RPMs)","vendor":"Red Hat","label":"rhel-7-server-rpms","id":"2456","type":"yum","gpgUrl":"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release","contentUrl":"/content/dist/rhel/server/7/$releasever/$basearch/os"}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '531' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/126/repository_sets/2456?organization_id=3 + response: + body: + string: ' {"enabled":true,"product":{"id":126,"name":"Red Hat Enterprise Linux + Server"},"repositories":[],"name":"Red Hat Enterprise Linux 7 Server (RPMs)","vendor":"Red + Hat","label":"rhel-7-server-rpms","id":"2456","type":"yum","gpgUrl":"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release","contentUrl":"/content/dist/rhel/server/7/$releasever/$basearch/os"} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '352' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/126/repository_sets/2456/available_repositories?organization_id=3 + response: + body: + string: '{"total":11,"subtotal":11,"page":null,"per_page":null,"error":null,"search":null,"sort":{"by":null,"order":null},"results":[{"substitutions":{"releasever":"7Server","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7Server/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7Server","pulp_id":"c0c0b38d-1fe0-4ea9-81e5-ca0b1d1032d3","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"7.9","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7.9/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7.9","pulp_id":"6c1568f7-a03b-4c95-85f6-766480d13083","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"7.8","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7.8/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7.8","pulp_id":"0e2e9062-a6b3-4be8-b555-bf054e76e1e3","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"7.7","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7.7/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7.7","pulp_id":"620763b1-55a4-4961-ba0b-119dc5823ab2","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"7.6","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7.6/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7.6","pulp_id":"bb63a709-8add-46cd-9c2e-841d0e72b46c","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"7.5","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7.5/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7.5","pulp_id":"ed4a419d-7a86-4ec2-9712-22c32929fce9","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"7.4","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7.4/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7.4","pulp_id":"eef3c191-a1f1-4f95-89ce-9ea586f72673","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"7.3","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7.3/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7.3","pulp_id":"0544a2fe-d190-4888-90de-4dd875d9f2d9","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"7.2","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7.2/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7.2","pulp_id":"2701f190-8e85-4fea-b0a8-80c1a75c6e2a","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"7.1","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7.1/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7.1","pulp_id":"c4e71f2b-5e30-44f8-ab81-5916ecade449","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"7.0","basearch":"x86_64"},"path":"/content/dist/rhel/server/7/7.0/x86_64/os","repo_name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7.0","pulp_id":"80d81a53-9156-4dfd-a657-f94e5347f9cd","name":"Red + Hat Enterprise Linux 7 Server (RPMs)","enabled":false,"promoted":false,"repository_id":null}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '3735' + status: + code: 200 + message: OK +- request: + body: '{"basearch": "x86_64", "releasever": "7Server", "organization_id": 3}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '69' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: PUT + uri: https://foreman.example.org/katello/api/products/126/repository_sets/2456/enable + response: + body: + string: ' {"id":"f1541a3f-7d2c-4aed-b201-c5bf6c938294","label":"Actions::Katello::RepositorySet::EnableRepository","pending":false,"action":"Enable + repository ''Red Hat Enterprise Linux 7 Server RPMs x86_64 7Server''; product + ''Red Hat Enterprise Linux Server''; organization ''Test Organization''","username":"admin","started_at":"2021-03-18 + 16:16:37 UTC","ended_at":"2021-03-18 16:16:39 UTC","state":"stopped","result":"success","progress":1.0,"input":{"services_checked":["pulp3","candlepin","candlepin_auth"],"repository":{"id":1,"name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7Server","label":"Red_Hat_Enterprise_Linux_7_Server_RPMs_x86_64_7Server"},"product":{"id":126,"name":"Red + Hat Enterprise Linux Server","label":"Red_Hat_Enterprise_Linux_Server","cp_id":"69"},"provider":{"id":4,"name":"Red + Hat"},"organization":{"id":3,"name":"Test Organization","label":"Test_Organization"},"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":3,"current_location_id":null},"output":{"repository":{"name":"Red + Hat Enterprise Linux 7 Server RPMs x86_64 7Server","id":1,"content_type":"yum"}},"humanized":{"action":"Enable","input":[["repository",{"text":"repository + ''Red Hat Enterprise Linux 7 Server RPMs x86_64 7Server''","link":null}],["product",{"text":"product + ''Red Hat Enterprise Linux Server''","link":"/products/126/"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:16:37 UTC","available_actions":{"cancellable":false,"resumable":false}} + + ' + headers: + Cache-Control: + - 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: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=94 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 202 + message: Accepted +version: 1 diff --git a/tests/test_playbooks/fixtures/content_rhel_role-2.yml b/tests/test_playbooks/fixtures/content_rhel_role-2.yml new file mode 100644 index 00000000..9cc988c4 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_rhel_role-2.yml @@ -0,0 +1,440 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-03-18 16:15:36 UTC\",\"updated_at\"\ + :\"2021-03-18 16:16:30 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Red+Hat+Enterprise+Linux+for+x86_64%22&per_page=4294967296 + response: + body: + string: '{"total":289,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux for x86_64\"","sort":{"by":"name","order":"asc"},"results":[{"id":21,"cp_id":"479","name":"Red + Hat Enterprise Linux for x86_64","label":"Red_Hat_Enterprise_Linux_for_x86_64","description":null,"provider_id":4,"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":0}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '650' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/21/repository_sets?organization_id=3&search=name%3D%22Red+Hat+Enterprise+Linux+8+for+x86_64+-+BaseOS+%28RPMs%29%22&per_page=4294967296 + response: + body: + string: '{"total":44,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS (RPMs)\"","sort":{"by":"name","order":"asc"},"results":[{"enabled":true,"product":{"id":21,"name":"Red + Hat Enterprise Linux for x86_64"},"repositories":[],"name":"Red Hat Enterprise + Linux 8 for x86_64 - BaseOS (RPMs)","vendor":"Red Hat","label":"rhel-8-for-x86_64-baseos-rpms","id":"7416","type":"yum","gpgUrl":"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release","contentUrl":"/content/dist/rhel8/$releasever/x86_64/baseos/os"}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '566' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/21/repository_sets/7416?organization_id=3 + response: + body: + string: ' {"enabled":true,"product":{"id":21,"name":"Red Hat Enterprise Linux + for x86_64"},"repositories":[],"name":"Red Hat Enterprise Linux 8 for x86_64 + - BaseOS (RPMs)","vendor":"Red Hat","label":"rhel-8-for-x86_64-baseos-rpms","id":"7416","type":"yum","gpgUrl":"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release","contentUrl":"/content/dist/rhel8/$releasever/x86_64/baseos/os"} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '375' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/21/repository_sets/7416/available_repositories?organization_id=3 + response: + body: + string: '{"total":5,"subtotal":5,"page":null,"per_page":null,"error":null,"search":null,"sort":{"by":null,"order":null},"results":[{"substitutions":{"releasever":"8"},"path":"/content/dist/rhel8/8/x86_64/baseos/os","repo_name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8","pulp_id":"ea8d8f05-c6b4-4602-8623-857487781686","name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"8.3"},"path":"/content/dist/rhel8/8.3/x86_64/baseos/os","repo_name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8.3","pulp_id":"0a27a33f-77ba-41ff-8118-0c82deeaaba4","name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"8.2"},"path":"/content/dist/rhel8/8.2/x86_64/baseos/os","repo_name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8.2","pulp_id":"d338d54d-4d5e-4f51-b584-c40a0d738d08","name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"8.1"},"path":"/content/dist/rhel8/8.1/x86_64/baseos/os","repo_name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8.1","pulp_id":"4c31321d-5d0d-4173-ae08-d31d0288bb7a","name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"8.0"},"path":"/content/dist/rhel8/8.0/x86_64/baseos/os","repo_name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8.0","pulp_id":"7e588d36-419a-4564-a1ce-1eb2ca7f31de","name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS (RPMs)","enabled":false,"promoted":false,"repository_id":null}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1743' + status: + code: 200 + message: OK +- request: + body: '{"releasever": "8", "organization_id": 3}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '41' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: PUT + uri: https://foreman.example.org/katello/api/products/21/repository_sets/7416/enable + response: + body: + string: ' {"id":"986cbb76-2c2a-4111-a87c-5308c3e83214","label":"Actions::Katello::RepositorySet::EnableRepository","pending":false,"action":"Enable + repository ''Red Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8''; product + ''Red Hat Enterprise Linux for x86_64''; organization ''Test Organization''","username":"admin","started_at":"2021-03-18 + 16:16:43 UTC","ended_at":"2021-03-18 16:16:47 UTC","state":"stopped","result":"success","progress":1.0,"input":{"services_checked":["pulp3","candlepin","candlepin_auth"],"repository":{"id":2,"name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8","label":"Red_Hat_Enterprise_Linux_8_for_x86_64_-_BaseOS_RPMs_8"},"product":{"id":21,"name":"Red + Hat Enterprise Linux for x86_64","label":"Red_Hat_Enterprise_Linux_for_x86_64","cp_id":"479"},"provider":{"id":4,"name":"Red + Hat"},"organization":{"id":3,"name":"Test Organization","label":"Test_Organization"},"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":3,"current_location_id":null},"output":{"repository":{"name":"Red + Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8","id":2,"content_type":"yum"}},"humanized":{"action":"Enable","input":[["repository",{"text":"repository + ''Red Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8''","link":null}],["product",{"text":"product + ''Red Hat Enterprise Linux for x86_64''","link":"/products/21/"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:16:43 UTC","available_actions":{"cancellable":false,"resumable":false}} + + ' + headers: + Cache-Control: + - 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: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=94 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 202 + message: Accepted +version: 1 diff --git a/tests/test_playbooks/fixtures/content_rhel_role-3.yml b/tests/test_playbooks/fixtures/content_rhel_role-3.yml new file mode 100644 index 00000000..f4475fb4 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_rhel_role-3.yml @@ -0,0 +1,441 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-03-18 16:15:36 UTC\",\"updated_at\"\ + :\"2021-03-18 16:16:30 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Red+Hat+Enterprise+Linux+for+x86_64%22&per_page=4294967296 + response: + body: + string: '{"total":289,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux for x86_64\"","sort":{"by":"name","order":"asc"},"results":[{"id":21,"cp_id":"479","name":"Red + Hat Enterprise Linux for x86_64","label":"Red_Hat_Enterprise_Linux_for_x86_64","description":null,"provider_id":4,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2021-03-18 + 16:16:48 UTC","last_sync_words":"less than a minute","organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":1}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '687' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/21/repository_sets?organization_id=3&search=name%3D%22Red+Hat+Enterprise+Linux+8+for+x86_64+-+AppStream+%28RPMs%29%22&per_page=4294967296 + response: + body: + string: '{"total":44,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux 8 for x86_64 - AppStream (RPMs)\"","sort":{"by":"name","order":"asc"},"results":[{"enabled":true,"product":{"id":21,"name":"Red + Hat Enterprise Linux for x86_64"},"repositories":[],"name":"Red Hat Enterprise + Linux 8 for x86_64 - AppStream (RPMs)","vendor":"Red Hat","label":"rhel-8-for-x86_64-appstream-rpms","id":"7441","type":"yum","gpgUrl":"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release","contentUrl":"/content/dist/rhel8/$releasever/x86_64/appstream/os"}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '578' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/21/repository_sets/7441?organization_id=3 + response: + body: + string: ' {"enabled":true,"product":{"id":21,"name":"Red Hat Enterprise Linux + for x86_64"},"repositories":[],"name":"Red Hat Enterprise Linux 8 for x86_64 + - AppStream (RPMs)","vendor":"Red Hat","label":"rhel-8-for-x86_64-appstream-rpms","id":"7441","type":"yum","gpgUrl":"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release","contentUrl":"/content/dist/rhel8/$releasever/x86_64/appstream/os"} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '384' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/21/repository_sets/7441/available_repositories?organization_id=3 + response: + body: + string: '{"total":5,"subtotal":5,"page":null,"per_page":null,"error":null,"search":null,"sort":{"by":null,"order":null},"results":[{"substitutions":{"releasever":"8"},"path":"/content/dist/rhel8/8/x86_64/appstream/os","repo_name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream RPMs 8","pulp_id":"6c176bd9-8000-43db-89b3-8bcb5dcb1abb","name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"8.3"},"path":"/content/dist/rhel8/8.3/x86_64/appstream/os","repo_name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream RPMs 8.3","pulp_id":"de92ec11-d28c-4bee-ba4b-a61c3e059845","name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"8.2"},"path":"/content/dist/rhel8/8.2/x86_64/appstream/os","repo_name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream RPMs 8.2","pulp_id":"016080c7-b767-43f3-903e-2b06ec59f24b","name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"8.1"},"path":"/content/dist/rhel8/8.1/x86_64/appstream/os","repo_name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream RPMs 8.1","pulp_id":"093d1a9e-617f-4138-af18-bed295ce1f6e","name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream (RPMs)","enabled":false,"promoted":false,"repository_id":null},{"substitutions":{"releasever":"8.0"},"path":"/content/dist/rhel8/8.0/x86_64/appstream/os","repo_name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream RPMs 8.0","pulp_id":"795abf64-835f-481b-a9f2-50234f109f6a","name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream (RPMs)","enabled":false,"promoted":false,"repository_id":null}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1788' + status: + code: 200 + message: OK +- request: + body: '{"releasever": "8", "organization_id": 3}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '41' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: PUT + uri: https://foreman.example.org/katello/api/products/21/repository_sets/7441/enable + response: + body: + string: ' {"id":"a798a4e6-5efc-4c58-8216-b92f46a56ccc","label":"Actions::Katello::RepositorySet::EnableRepository","pending":false,"action":"Enable + repository ''Red Hat Enterprise Linux 8 for x86_64 - AppStream RPMs 8''; product + ''Red Hat Enterprise Linux for x86_64''; organization ''Test Organization''","username":"admin","started_at":"2021-03-18 + 16:16:51 UTC","ended_at":"2021-03-18 16:16:54 UTC","state":"stopped","result":"success","progress":1.0,"input":{"services_checked":["pulp3","candlepin","candlepin_auth"],"repository":{"id":3,"name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream RPMs 8","label":"Red_Hat_Enterprise_Linux_8_for_x86_64_-_AppStream_RPMs_8"},"product":{"id":21,"name":"Red + Hat Enterprise Linux for x86_64","label":"Red_Hat_Enterprise_Linux_for_x86_64","cp_id":"479"},"provider":{"id":4,"name":"Red + Hat"},"organization":{"id":3,"name":"Test Organization","label":"Test_Organization"},"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":3,"current_location_id":null},"output":{"repository":{"name":"Red + Hat Enterprise Linux 8 for x86_64 - AppStream RPMs 8","id":3,"content_type":"yum"}},"humanized":{"action":"Enable","input":[["repository",{"text":"repository + ''Red Hat Enterprise Linux 8 for x86_64 - AppStream RPMs 8''","link":null}],["product",{"text":"product + ''Red Hat Enterprise Linux for x86_64''","link":"/products/21/"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:16:51 UTC","available_actions":{"cancellable":false,"resumable":false}} + + ' + headers: + Cache-Control: + - 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: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=94 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 202 + message: Accepted +version: 1 diff --git a/tests/test_playbooks/fixtures/content_rhel_role-5.yml b/tests/test_playbooks/fixtures/content_rhel_role-5.yml new file mode 100644 index 00000000..99fbc204 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_rhel_role-5.yml @@ -0,0 +1,371 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-03-18 16:15:36 UTC\",\"updated_at\"\ + :\"2021-03-18 16:16:30 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Red+Hat+Enterprise+Linux+Server%22&per_page=4294967296 + response: + body: + string: '{"total":289,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux Server\"","sort":{"by":"name","order":"asc"},"results":[{"id":126,"cp_id":"69","name":"Red + Hat Enterprise Linux Server","label":"Red_Hat_Enterprise_Linux_Server","description":null,"provider_id":4,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2021-03-18 + 16:16:40 UTC","last_sync_words":"less than a minute","organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":1}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '675' + status: + code: 200 + message: OK +- request: + body: '{}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '2' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/products/126/sync + response: + body: + string: ' {"id":"9770cad7-e6ff-465d-9de0-95fbbdb6dc97","label":"Actions::BulkAction","pending":true,"action":"Bulk + action","username":"admin","started_at":"2021-03-18 16:16:57 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"action_class":"Actions::Katello::Repository::Sync","target_ids":[1],"target_class":"Katello::Repository","args":[],"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Bulk + action","input":null,"output":null,"errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:16:57 UTC","available_actions":{"cancellable":false,"resumable":false}} + + ' + headers: + Cache-Control: + - 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: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 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/9770cad7-e6ff-465d-9de0-95fbbdb6dc97 + response: + body: + string: '{"id":"9770cad7-e6ff-465d-9de0-95fbbdb6dc97","label":"Actions::BulkAction","pending":true,"action":"Bulk + action","username":"admin","started_at":"2021-03-18 16:16:57 UTC","ended_at":null,"state":"running","result":"pending","progress":0.0,"input":{"action_class":"Actions::Katello::Repository::Sync","target_ids":[1],"target_class":"Katello::Repository","args":[],"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{"planned_count":1,"cancelled_count":0,"total_count":1,"failed_count":0,"pending_count":1,"success_count":0},"humanized":{"action":"Synchronize","input":["synchronize",["repository",{"text":"repository + ''Red Hat Enterprise Linux 7 Server RPMs x86_64 7Server''","link":null}],["product",{"text":"product + ''Red Hat Enterprise Linux Server''","link":"/products/126/"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}],"..."],"output":"1 + task(s), 0 success, 0 fail","errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:16:57 UTC","available_actions":{"cancellable":true,"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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1132' + 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/foreman_tasks/api/tasks/9770cad7-e6ff-465d-9de0-95fbbdb6dc97 + response: + body: + string: '{"id":"9770cad7-e6ff-465d-9de0-95fbbdb6dc97","label":"Actions::BulkAction","pending":false,"action":"Synchronize + synchronize; repository ''Red Hat Enterprise Linux 7 Server RPMs x86_64 7Server''; + product ''Red Hat Enterprise Linux Server''; organization ''Test Organization''; + ...","username":"admin","started_at":"2021-03-18 16:16:57 UTC","ended_at":"2021-03-18 + 17:08:33 UTC","state":"stopped","result":"success","progress":1.0,"input":{"action_class":"Actions::Katello::Repository::Sync","target_ids":[1],"target_class":"Katello::Repository","args":[],"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{"planned_count":1,"cancelled_count":0,"total_count":1,"failed_count":0,"pending_count":0,"success_count":1},"humanized":{"action":"Synchronize","input":["synchronize",["repository",{"text":"repository + ''Red Hat Enterprise Linux 7 Server RPMs x86_64 7Server''","link":null}],["product",{"text":"product + ''Red Hat Enterprise Linux Server''","link":"/products/126/"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}],"..."],"output":"1 + task(s), 1 success, 0 fail","errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:16:57 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1317' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/content_rhel_role-7.yml b/tests/test_playbooks/fixtures/content_rhel_role-7.yml new file mode 100644 index 00000000..6d3acbfa --- /dev/null +++ b/tests/test_playbooks/fixtures/content_rhel_role-7.yml @@ -0,0 +1,371 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-03-18 16:15:36 UTC\",\"updated_at\"\ + :\"2021-03-18 16:16:30 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Red+Hat+Enterprise+Linux+for+x86_64%22&per_page=4294967296 + response: + body: + string: '{"total":289,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux for x86_64\"","sort":{"by":"name","order":"asc"},"results":[{"id":21,"cp_id":"479","name":"Red + Hat Enterprise Linux for x86_64","label":"Red_Hat_Enterprise_Linux_for_x86_64","description":null,"provider_id":4,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2021-03-18 + 16:16:55 UTC","last_sync_words":"less than a minute","organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '687' + status: + code: 200 + message: OK +- request: + body: '{}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '2' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/products/21/sync + response: + body: + string: ' {"id":"70e782e8-8143-472b-8ecc-867d19c2ec7e","label":"Actions::BulkAction","pending":true,"action":"Bulk + action","username":"admin","started_at":"2021-03-18 16:16:57 UTC","ended_at":null,"state":"planned","result":"pending","progress":0.0,"input":{"action_class":"Actions::Katello::Repository::Sync","target_ids":[2,3],"target_class":"Katello::Repository","args":[],"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{},"humanized":{"action":"Bulk + action","input":null,"output":null,"errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:16:57 UTC","available_actions":{"cancellable":false,"resumable":false}} + + ' + headers: + Cache-Control: + - 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: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 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/70e782e8-8143-472b-8ecc-867d19c2ec7e + response: + body: + string: '{"id":"70e782e8-8143-472b-8ecc-867d19c2ec7e","label":"Actions::BulkAction","pending":true,"action":"Bulk + action","username":"admin","started_at":"2021-03-18 16:16:57 UTC","ended_at":null,"state":"running","result":"pending","progress":0.0,"input":{"action_class":"Actions::Katello::Repository::Sync","target_ids":[2,3],"target_class":"Katello::Repository","args":[],"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{"planned_count":2,"cancelled_count":0,"total_count":2,"failed_count":0,"pending_count":2,"success_count":0},"humanized":{"action":"Synchronize","input":["synchronize",["repository",{"text":"repository + ''Red Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8''","link":null}],["product",{"text":"product + ''Red Hat Enterprise Linux for x86_64''","link":"/products/21/"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}],"..."],"output":"2 + task(s), 0 success, 0 fail","errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:16:57 UTC","available_actions":{"cancellable":true,"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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1137' + 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/foreman_tasks/api/tasks/70e782e8-8143-472b-8ecc-867d19c2ec7e + response: + body: + string: '{"id":"70e782e8-8143-472b-8ecc-867d19c2ec7e","label":"Actions::BulkAction","pending":false,"action":"Synchronize + synchronize; repository ''Red Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs + 8''; product ''Red Hat Enterprise Linux for x86_64''; organization ''Test + Organization''; ...","username":"admin","started_at":"2021-03-18 16:16:57 + UTC","ended_at":"2021-03-18 16:35:24 UTC","state":"stopped","result":"success","progress":1.0,"input":{"action_class":"Actions::Katello::Repository::Sync","target_ids":[2,3],"target_class":"Katello::Repository","args":[],"current_request_id":null,"current_timezone":"UTC","current_user_id":4,"current_organization_id":null,"current_location_id":null},"output":{"planned_count":2,"cancelled_count":0,"total_count":2,"failed_count":0,"pending_count":0,"success_count":2},"humanized":{"action":"Synchronize","input":["synchronize",["repository",{"text":"repository + ''Red Hat Enterprise Linux 8 for x86_64 - BaseOS RPMs 8''","link":null}],["product",{"text":"product + ''Red Hat Enterprise Linux for x86_64''","link":"/products/21/"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/3/edit"}],"..."],"output":"2 + task(s), 2 success, 0 fail","errors":[]},"cli_example":null,"start_at":"2021-03-18 + 16:16:57 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=49 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1326' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/content_rhel_role-8.yml b/tests/test_playbooks/fixtures/content_rhel_role-8.yml new file mode 100644 index 00000000..fd53a4cf --- /dev/null +++ b/tests/test_playbooks/fixtures/content_rhel_role-8.yml @@ -0,0 +1,433 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-03-18 16:15:36 UTC\",\"updated_at\"\ + :\"2021-03-18 16:16:30 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/sync_plans?search=name%3D%22RHEL+Sync+Plan%22&per_page=4294967296 + response: + body: + string: '{"total":0,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"RHEL + Sync Plan\"","sort":{"by":"name","order":"asc"},"results":[]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '154' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Red+Hat+Enterprise+Linux+Server%22&per_page=4294967296 + response: + body: + string: '{"total":289,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux Server\"","sort":{"by":"name","order":"asc"},"results":[{"id":126,"cp_id":"69","name":"Red + Hat Enterprise Linux Server","label":"Red_Hat_Enterprise_Linux_Server","description":null,"provider_id":4,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2021-03-18 + 16:16:40 UTC","last_sync_words":"less than a minute","organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":1}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '675' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Red+Hat+Enterprise+Linux+for+x86_64%22&per_page=4294967296 + response: + body: + string: '{"total":289,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux for x86_64\"","sort":{"by":"name","order":"asc"},"results":[{"id":21,"cp_id":"479","name":"Red + Hat Enterprise Linux for x86_64","label":"Red_Hat_Enterprise_Linux_for_x86_64","description":null,"provider_id":4,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2021-03-18 + 16:16:55 UTC","last_sync_words":"less than a minute","organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":null,"repository_count":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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '687' + status: + code: 200 + message: OK +- request: + body: '{"name": "RHEL Sync Plan", "interval": "daily", "sync_date": "2021-02-02 + 00:00:00 UTC", "enabled": true}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '104' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/organizations/3/sync_plans + response: + body: + string: ' {"id":1,"organization_id":3,"name":"RHEL Sync Plan","description":null,"interval":"daily","next_sync":"2021-03-19 + 00:00:00 UTC","sync_date":"2021-02-02 00:00:00 UTC","created_at":"2021-03-18 + 16:16:58 UTC","updated_at":"2021-03-18 16:16:58 UTC","enabled":true,"foreman_tasks_recurring_logic_id":1,"cron_expression":null,"products":[],"permissions":{"view_sync_plans":true,"edit_sync_plans":true,"destroy_sync_plans":true}} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +- request: + body: '{"product_ids": [21, 126]}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '26' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: PUT + uri: https://foreman.example.org/katello/api/organizations/3/sync_plans/1/add_products + response: + body: + string: ' {"id":1,"organization_id":3,"name":"RHEL Sync Plan","description":null,"interval":"daily","next_sync":"2021-03-19 + 00:00:00 UTC","sync_date":"2021-02-02 00:00:00 UTC","created_at":"2021-03-18 + 16:16:58 UTC","updated_at":"2021-03-18 16:16:58 UTC","enabled":true,"foreman_tasks_recurring_logic_id":1,"cron_expression":null,"products":[{"id":21,"cp_id":"479","name":"Red + Hat Enterprise Linux for x86_64","label":"Red_Hat_Enterprise_Linux_for_x86_64","description":null,"sync_state":"planning","last_sync":"2021-03-18 + 16:16:58 UTC","last_sync_words":"less than a minute","repository_count":2},{"id":126,"cp_id":"69","name":"Red + Hat Enterprise Linux Server","label":"Red_Hat_Enterprise_Linux_Server","description":null,"sync_state":"Running","last_sync":"2021-03-18 + 16:16:57 UTC","last_sync_words":"less than a minute","repository_count":1}],"permissions":{"view_sync_plans":true,"edit_sync_plans":true,"destroy_sync_plans":true}} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=94 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '926' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/content_rhel_role-9.yml b/tests/test_playbooks/fixtures/content_rhel_role-9.yml new file mode 100644 index 00000000..91c6e3ab --- /dev/null +++ b/tests/test_playbooks/fixtures/content_rhel_role-9.yml @@ -0,0 +1,367 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-03-18 16:15:36 UTC\",\"updated_at\"\ + :\"2021-03-18 16:16:30 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/activation_keys?search=name%3D%22basic_rhel_key%22&per_page=4294967296 + response: + body: + string: '{"total":0,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"basic_rhel_key\"","sort":{"by":"name","order":"asc"},"results":[]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '154' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/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":2,"name":"Library","label":"Library","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2021-03-18 + 16:15:38 UTC","updated_at":"2021-03-18 16:15:38 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":3,"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}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '962' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/content_views?search=name%3D%22Default+Organization+View%22&per_page=4294967296 + response: + body: + string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Default + Organization View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":true,"force_puppet_environment":false,"version_count":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[],"id":2,"name":"Default + Organization View","label":"989c47a5-696c-4efb-b2d1-973cdedef1c3","description":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2021-03-18 + 16:15:38 UTC","updated_at":"2021-03-18 16:15:38 UTC","environments":[{"id":2,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[],"puppet_modules":[],"versions":[{"id":2,"version":"1.0","published":"2021-03-18 + 16:15:38 UTC","environment_ids":[2]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":"2021-03-18 + 16:15:38 UTC","permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1189' + status: + code: 200 + message: OK +- request: + body: '{"organization_id": 3, "name": "basic_rhel_key", "description": "Generated + by ansible role theforeman.foreman.content_rhel", "environment_id": 2, "content_view_id": + 2}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '167' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/activation_keys + response: + body: + string: ' {"service_level":null,"content_overrides":[],"id":1,"name":"basic_rhel_key","description":"Generated + by ansible role theforeman.foreman.content_rhel","unlimited_hosts":true,"auto_attach":true,"content_view_id":2,"environment_id":2,"usage_count":0,"user_id":4,"max_hosts":null,"release_version":null,"purpose_usage":null,"purpose_role":null,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2021-03-18 + 16:17:02 UTC","updated_at":"2021-03-18 16:17:03 UTC","content_view":{"id":2,"name":"Default + Organization View"},"environment":{"name":"Library","id":2},"products":[],"host_collections":[],"purpose_addons":[],"permissions":{"view_activation_keys":true,"edit_activation_keys":true,"destroy_activation_keys":true}} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/vcr_python_wrapper.py b/tests/vcr_python_wrapper.py index a7e41ac0..1389cee0 100755 --- a/tests/vcr_python_wrapper.py +++ b/tests/vcr_python_wrapper.py @@ -171,7 +171,7 @@ def filter_request(request): if test_params['test_name'] == 'host': fam_vcr.register_matcher('host_body', host_body_matcher) body_matcher = 'host_body' - elif test_params['test_name'] in ['subscription_manifest', 'manifest_role']: + elif test_params['test_name'] in ['subscription_manifest', 'manifest_role', 'content_rhel_role']: fam_vcr.register_matcher('subscription_manifest_body', subscription_manifest_body_matcher) body_matcher = 'subscription_manifest_body' elif test_params['test_name'] == 'job_invocation': From f1ae01b4143d405707c71e885e22bcee983688d4 Mon Sep 17 00:00:00 2001 From: "Eric D. Helms" Date: Thu, 11 Mar 2021 10:33:20 -0500 Subject: [PATCH 15/56] Add content_view_version_info module --- plugins/doc_fragments/foreman.py | 19 ++ plugins/module_utils/foreman_helper.py | 4 +- plugins/modules/content_view_version_info.py | 90 ++++++ .../apidoc/content_view_version_info.json | 1 + .../content_view_version_info.yml | 120 ++++++++ .../fixtures/content_view_version_info-0.yml | 265 ++++++++++++++++++ .../fixtures/content_view_version_info-1.yml | 254 +++++++++++++++++ 7 files changed, 752 insertions(+), 1 deletion(-) create mode 100644 plugins/modules/content_view_version_info.py create mode 120000 tests/fixtures/apidoc/content_view_version_info.json create mode 100644 tests/test_playbooks/content_view_version_info.yml create mode 100644 tests/test_playbooks/fixtures/content_view_version_info-0.yml create mode 100644 tests/test_playbooks/fixtures/content_view_version_info-1.yml diff --git a/plugins/doc_fragments/foreman.py b/plugins/doc_fragments/foreman.py index f32225e5..281a9b46 100644 --- a/plugins/doc_fragments/foreman.py +++ b/plugins/doc_fragments/foreman.py @@ -352,6 +352,25 @@ class ModuleDocFragment(object): type: str ''' + INFOMODULEWITHOUTNAME = ''' +options: + location: + description: + - Label of the Location to scope the search for. + required: false + type: str + organization: + description: + - Name of the Organization to scope the search for. + required: false + type: str + search: + description: + - Search query to use + - If None, all resources are returned. + type: str +''' + KATELLOINFOMODULE = ''' options: organization: diff --git a/plugins/module_utils/foreman_helper.py b/plugins/module_utils/foreman_helper.py index ec99fe30..432c76df 100644 --- a/plugins/module_utils/foreman_helper.py +++ b/plugins/module_utils/foreman_helper.py @@ -1349,7 +1349,9 @@ def __init__(self, **kwargs): location=dict(type='entity'), ) foreman_spec.update(kwargs.pop('foreman_spec', {})) - mutually_exclusive = kwargs.pop('mutually_exclusive', []) + [['name', 'search']] + mutually_exclusive = kwargs.pop('mutually_exclusive', []) + if not foreman_spec['name'].get('invisible', False): + mutually_exclusive.extend([['name', 'search']]) super(ForemanInfoAnsibleModule, self).__init__(foreman_spec=foreman_spec, mutually_exclusive=mutually_exclusive, **kwargs) def run(self, **kwargs): diff --git a/plugins/modules/content_view_version_info.py b/plugins/modules/content_view_version_info.py new file mode 100644 index 00000000..832efc33 --- /dev/null +++ b/plugins/modules/content_view_version_info.py @@ -0,0 +1,90 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# (c) 2021 Eric Helms +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +DOCUMENTATION = ''' +--- +module: content_view_version_info +version_added: 2.1.0 +short_description: Fetch information about Content Views +description: + - Fetch information about Content Views +author: + - "Eric Helms (@ehelms)" +options: + content_view: + description: + - Content View to which the Version belongs + required: true + type: str +extends_documentation_fragment: + - theforeman.foreman.foreman + - theforeman.foreman.foreman.katelloinfomodule + - theforeman.foreman.foreman.infomodulewithoutname +''' + +EXAMPLES = ''' +- name: "Show a content view version" + theforeman.foreman.content_view_version_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + content_view: "CentOS 8 View" + search: 'version = "4.0"' + +- name: "Show all content view_versions for a content view" + theforeman.foreman.content_view_version_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + content_view: "CentOS 8 View" +''' + +RETURN = ''' +content_view_versions: + description: List of all found content_view_versions and their details + returned: success and I(search) was passed + type: list + elements: dict +''' + +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( + KatelloInfoAnsibleModule, +) + + +class KatelloContentViewVersionInfo(KatelloInfoAnsibleModule): + pass + + +def main(): + module = KatelloContentViewVersionInfo( + foreman_spec=dict( + content_view=dict(type='entity', scope=['organization'], required=True), + name=dict(invisible=True), + ), + ) + + with module.api_connection(): + module.run() + + +if __name__ == '__main__': + main() diff --git a/tests/fixtures/apidoc/content_view_version_info.json b/tests/fixtures/apidoc/content_view_version_info.json new file mode 120000 index 00000000..8e89899a --- /dev/null +++ b/tests/fixtures/apidoc/content_view_version_info.json @@ -0,0 +1 @@ +katello.json \ No newline at end of file diff --git a/tests/test_playbooks/content_view_version_info.yml b/tests/test_playbooks/content_view_version_info.yml new file mode 100644 index 00000000..c0276e21 --- /dev/null +++ b/tests/test_playbooks/content_view_version_info.yml @@ -0,0 +1,120 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include: tasks/organization.yml + vars: + organization_state: present + - include: tasks/product.yml + vars: + product_state: present + - include: tasks/repository.yml + vars: + repository_state: present + - include: 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/content_view.yml + vars: + content_view_state: absent + ignore_errors: true + - include: tasks/content_view.yml + vars: + content_view_state: present + repositories: + - name: "Test Repository" + product: "Test Product" + - name: publish CV version 1.0 + include_tasks: tasks/content_view_version.yml + vars: + description: version-1.0 + version: 1.0 + - name: promote CV from Library to Test + include_tasks: tasks/content_view_version.yml + vars: + current_lifecycle_environment: Library + lifecycle_environments: + - Library + - Test + - name: publish CV version 2.0 + include_tasks: tasks/content_view_version.yml + vars: + description: version-2.0 + version: 2.0 + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: fetch all content view versions + content_view_version_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + organization: "Test Organization" + content_view: "Test Content View" + register: content_view_version_info + - name: check content_view_version details + assert: + that: + - content_view_version_info['content_view_versions'][0]['version'] == "2.0" + - content_view_version_info['content_view_versions'][1]['version'] == "1.0" + + - name: search content view version info + content_view_version_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + organization: "Test Organization" + content_view: "Test Content View" + search: 'version = "1.0"' + register: content_view_version_info + - name: check content_view details + assert: + that: + - content_view_version_info['content_view_versions'][0]['version'] == "1.0" + +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include: tasks/content_view.yml + vars: + content_view_state: absent + ignore_errors: true + - include: tasks/repository.yml + vars: + repository_state: absent + ignore_errors: true + - include: tasks/product.yml + vars: + product_state: absent + ignore_errors: true + - include: tasks/organization.yml + vars: + organization_state: absent diff --git a/tests/test_playbooks/fixtures/content_view_version_info-0.yml b/tests/test_playbooks/fixtures/content_view_version_info-0.yml new file mode 100644 index 00000000..6ca2db29 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_view_version_info-0.yml @@ -0,0 +1,265 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 3,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2021-03-11 + 16:44:29 UTC\",\"updated_at\":\"2021-03-11 16:44:29 UTC\",\"id\":11,\"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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '389' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/11/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":2,"latest_version":"2.0","auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[65],"id":23,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":11,"organization":{"name":"Test + Organization","label":"Test_Organization","id":11},"created_at":"2021-03-11 + 16:49:55 UTC","updated_at":"2021-03-11 16:50:10 UTC","environments":[{"id":21,"name":"Test","label":"test","permissions":{"readable":true}},{"id":20,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":65,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":27,"version":"1.0","published":"2021-03-11 + 16:49:56 UTC","environment_ids":[21]},{"id":28,"version":"2.0","published":"2021-03-11 + 16:50:10 UTC","environment_ids":[20]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"3.0","last_published":"2021-03-11 + 16:50:10 UTC","permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 11; Test Organization + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1402' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_views/23/content_view_versions?organization_id=11&per_page=4294967296 + response: + body: + string: '{"total":2,"subtotal":2,"page":1,"per_page":"4294967296","error":null,"search":null,"sort":{"by":"version","order":"desc"},"results":[{"version":"2.0","major":2,"minor":0,"composite_content_view_ids":[],"published_in_composite_content_view_ids":[],"content_view_id":23,"default":false,"description":"version-2.0","id":28,"name":"Test + Content View 2.0","created_at":"2021-03-11 16:50:10 UTC","updated_at":"2021-03-11 + 16:50:14 UTC","content_view":{"id":23,"name":"Test Content View","label":"Test_Content_View"},"composite_content_views":[],"composite_content_view_versions":[],"published_in_composite_content_views":[],"environments":[{"id":20,"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":73,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","library_instance_id":65}],"last_event":{"user":"admin","status":"successful","description":"version-2.0","action":"publish","created_at":"2021-03-11 + 16:50:10 UTC","updated_at":"2021-03-11 16:50:14 UTC","environment":null,"task":{"id":"9f4a7ded-b988-420e-9011-e3b9588a9c4b","label":"Actions::Katello::ContentView::Publish","pending":false,"action":"Publish + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2021-03-11 + 16:50:10 UTC","ended_at":"2021-03-11 16:50:14 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":23,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":11,"name":"Test + Organization","label":"Test_Organization"},"services_checked":["pulp3","candlepin","candlepin_auth"],"history_id":55,"content_view_id":23,"auto_publish_composite_ids":[],"content_view_version_name":"Test + Content View 2.0","content_view_version_id":28,"environment_id":20,"user_id":4,"skip_promotion":null,"current_request_id":"08ef46d3-2bc8-41c8-b7a2-d343bf0fc144","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{"content_view_id":23,"content_view_version_id":28,"skip_promotion":null},"humanized":{"action":"Publish","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/23/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/11/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2021-03-11 + 16:50:10 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"2.0","publish":true,"version_id":28,"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,"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"puppet_module_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}},{"version":"1.0","major":1,"minor":0,"composite_content_view_ids":[],"published_in_composite_content_view_ids":[],"content_view_id":23,"default":false,"description":"version-1.0","id":27,"name":"Test + Content View 1.0","created_at":"2021-03-11 16:49:56 UTC","updated_at":"2021-03-11 + 16:50:00 UTC","content_view":{"id":23,"name":"Test Content View","label":"Test_Content_View"},"composite_content_views":[],"composite_content_view_versions":[],"published_in_composite_content_views":[],"environments":[{"id":21,"name":"Test","label":"test","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":70,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","library_instance_id":65}],"last_event":{"user":"admin","status":"successful","description":null,"action":"promotion","created_at":"2021-03-11 + 16:50:03 UTC","updated_at":"2021-03-11 16:50:07 UTC","environment":{"id":21,"name":"Test"},"task":{"id":"c516bfce-3951-4763-8826-f565663770b8","label":"Actions::Katello::ContentView::Promote","pending":false,"action":"Promote + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2021-03-11 + 16:50:03 UTC","ended_at":"2021-03-11 16:50:07 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":23,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":11,"name":"Test + Organization","label":"Test_Organization"},"environments":["Test"],"services_checked":["candlepin","candlepin_auth","pulp3"],"current_request_id":"a19f475a-ed29-4e7d-a5b8-910b1e24743a","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Promote","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/23/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/11/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2021-03-11 + 16:50:03 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":false,"version_id":27,"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,"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"puppet_module_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}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 11; Test Organization + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '5810' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/content_view_version_info-1.yml b/tests/test_playbooks/fixtures/content_view_version_info-1.yml new file mode 100644 index 00000000..97ad41f7 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_view_version_info-1.yml @@ -0,0 +1,254 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 3,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2021-03-11 + 16:44:29 UTC\",\"updated_at\":\"2021-03-11 16:44:29 UTC\",\"id\":11,\"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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '389' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/11/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":2,"latest_version":"2.0","auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[65],"id":23,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":11,"organization":{"name":"Test + Organization","label":"Test_Organization","id":11},"created_at":"2021-03-11 + 16:49:55 UTC","updated_at":"2021-03-11 16:50:10 UTC","environments":[{"id":21,"name":"Test","label":"test","permissions":{"readable":true}},{"id":20,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[{"id":65,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[{"id":27,"version":"1.0","published":"2021-03-11 + 16:49:56 UTC","environment_ids":[21]},{"id":28,"version":"2.0","published":"2021-03-11 + 16:50:10 UTC","environment_ids":[20]}],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"3.0","last_published":"2021-03-11 + 16:50:10 UTC","permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 11; Test Organization + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1402' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_views/23/content_view_versions?organization_id=11&search=version+%3D+%221.0%22&per_page=4294967296 + response: + body: + string: '{"total":2,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"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":23,"default":false,"description":"version-1.0","id":27,"name":"Test + Content View 1.0","created_at":"2021-03-11 16:49:56 UTC","updated_at":"2021-03-11 + 16:50:00 UTC","content_view":{"id":23,"name":"Test Content View","label":"Test_Content_View"},"composite_content_views":[],"composite_content_view_versions":[],"published_in_composite_content_views":[],"environments":[{"id":21,"name":"Test","label":"test","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":70,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","library_instance_id":65}],"last_event":{"user":"admin","status":"successful","description":null,"action":"promotion","created_at":"2021-03-11 + 16:50:03 UTC","updated_at":"2021-03-11 16:50:07 UTC","environment":{"id":21,"name":"Test"},"task":{"id":"c516bfce-3951-4763-8826-f565663770b8","label":"Actions::Katello::ContentView::Promote","pending":false,"action":"Promote + content view ''Test Content View''; organization ''Test Organization''","username":"admin","started_at":"2021-03-11 + 16:50:03 UTC","ended_at":"2021-03-11 16:50:07 UTC","state":"stopped","result":"success","progress":1.0,"input":{"content_view":{"id":23,"name":"Test + Content View","label":"Test_Content_View"},"organization":{"id":11,"name":"Test + Organization","label":"Test_Organization"},"environments":["Test"],"services_checked":["candlepin","candlepin_auth","pulp3"],"current_request_id":"a19f475a-ed29-4e7d-a5b8-910b1e24743a","current_timezone":"UTC","current_organization_id":null,"current_location_id":null,"current_user_id":4},"output":{},"humanized":{"action":"Promote","input":[["content_view",{"text":"content + view ''Test Content View''","link":"/content_views/23/versions"}],["organization",{"text":"organization + ''Test Organization''","link":"/organizations/11/edit"}]],"output":"","errors":[]},"cli_example":null,"start_at":"2021-03-11 + 16:50:03 UTC","available_actions":{"cancellable":false,"resumable":false}},"version":"1.0","publish":false,"version_id":27,"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,"rpm_count":0,"modulemd_count":0,"erratum_count":0,"package_group_count":0,"srpm_count":0,"puppet_module_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}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 11; Test Organization + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '2866' + status: + code: 200 + message: OK +version: 1 From 19fe3f43f9114cde234826b0806427f78637d23b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20R=C5=AF=C5=BEi=C4=8Dka?= Date: Mon, 22 Mar 2021 15:51:28 +0100 Subject: [PATCH 16/56] Foreman facts uploading correctly merges facts (#1155) * Foreman facts uploading correctly merges facts The callback plugin collects facts during the run, merges them correctly and uploads them once at the end. Adapted from https://github.com/ansible/ansible/pull/51546 --- changelogs/fragments/foreman-fact-upload.yml | 2 + plugins/callback/foreman.py | 223 ++++++++++--------- 2 files changed, 124 insertions(+), 101 deletions(-) create mode 100644 changelogs/fragments/foreman-fact-upload.yml diff --git a/changelogs/fragments/foreman-fact-upload.yml b/changelogs/fragments/foreman-fact-upload.yml new file mode 100644 index 00000000..fd73eaea --- /dev/null +++ b/changelogs/fragments/foreman-fact-upload.yml @@ -0,0 +1,2 @@ +minor_changes: + - callback plugin - collect facts during the run, merge them correctly and upload them once at the end diff --git a/plugins/callback/foreman.py b/plugins/callback/foreman.py index 6a44c2eb..37e50ed2 100644 --- a/plugins/callback/foreman.py +++ b/plugins/callback/foreman.py @@ -88,25 +88,65 @@ HAS_REQUESTS = False from ansible.module_utils._text import to_text +from ansible.module_utils.parsing.convert_bool import boolean as to_bool from ansible.plugins.callback import CallbackBase +def build_log(data): + """ + Transform the internal log structure to one accepted by Foreman's + config_report API. + """ + for source, msg in data: + if 'failed' in msg: + level = 'err' + elif 'changed' in msg and msg['changed']: + level = 'notice' + else: + level = 'info' + + yield { + "log": { + 'sources': { + 'source': source, + }, + 'messages': { + 'message': json.dumps(msg), + }, + 'level': level, + } + } + + +def get_time(): + """ + Return the time for measuring duration. Prefers monotonic time but + falls back to the regular time on older Python versions. + """ + try: + return time.monotonic() + except AttributeError: + return time.time() + + +def get_now(): + """ + Return the current timestamp as a string to be sent over the network. + """ + return datetime.utcnow().isoformat() + + class CallbackModule(CallbackBase): CALLBACK_VERSION = 2.0 CALLBACK_TYPE = 'notification' CALLBACK_NAME = 'theforeman.foreman.foreman' CALLBACK_NEEDS_WHITELIST = True - FOREMAN_HEADERS = { - "Content-Type": "application/json", - "Accept": "application/json" - } - TIME_FORMAT = "%Y-%m-%d %H:%M:%S %f" - def __init__(self): super(CallbackModule, self).__init__() self.items = defaultdict(list) - self.start_time = int(time.time()) + self.facts = defaultdict(dict) + self.start_time = get_time() def set_options(self, task_keys=None, var_options=None, direct=None): @@ -115,88 +155,73 @@ def set_options(self, task_keys=None, var_options=None, direct=None): if self.get_option('disable_callback'): self._disable_plugin('Callback disabled by environment.') - self.FOREMAN_URL = self.get_option('url') - self.FOREMAN_SSL_CERT = (self.get_option('client_cert'), self.get_option('client_key')) - self.FOREMAN_SSL_VERIFY = str(self.get_option('verify_certs')) - - self.ssl_verify = self._ssl_verify() + self.foreman_url = self.get_option('url') + ssl_cert = self.get_option('client_cert') + ssl_key = self.get_option('client_key') if HAS_REQUESTS: - requests_major = int(requests.__version__.split('.')[0]) - if requests_major < 2: - self._disable_plugin('The `requests` python module is too old.') + requests_version = tuple(map(int, requests.__version__.split('.'))) + if requests_version < (2, 14): + self._disable_plugin(u'The `requests` python module is older than 2.14.0.') else: - self._disable_plugin('The `requests` python module is not installed.') + self._disable_plugin(u'The `requests` python module is not installed') + + if self.foreman_url.startswith('https://'): + if not os.path.exists(ssl_cert): + self._disable_plugin(u'FOREMAN_SSL_CERT %s not found.' % ssl_cert) - if self.FOREMAN_URL.startswith('https://'): - if not os.path.exists(self.FOREMAN_SSL_CERT[0]): - self._disable_plugin('FOREMAN_SSL_CERT %s not found.' % self.FOREMAN_SSL_CERT[0]) + if not os.path.exists(ssl_key): + self._disable_plugin(u'FOREMAN_SSL_KEY %s not found.' % ssl_key) - if not os.path.exists(self.FOREMAN_SSL_CERT[1]): - self._disable_plugin('FOREMAN_SSL_KEY %s not found.' % self.FOREMAN_SSL_CERT[1]) + self.session = requests.Session() + self.session.verify = self._ssl_verify(str(self.get_option('verify_certs'))) + self.session.cert = (ssl_cert, ssl_key) def _disable_plugin(self, msg): self.disabled = True if msg: - self._display.warning(msg + ' Disabling the Foreman callback plugin.') + self._display.warning(msg + u' Disabling the Foreman callback plugin.') else: - self._display.warning('Disabling the Foreman callback plugin.') + self._display.warning(u'Disabling the Foreman callback plugin.') - def _ssl_verify(self): - if self.FOREMAN_SSL_VERIFY.lower() in ["1", "true", "on"]: - verify = True - elif self.FOREMAN_SSL_VERIFY.lower() in ["0", "false", "off"]: + def _ssl_verify(self, option): + try: + verify = to_bool(option) + except TypeError: + verify = option + + if verify is False: # is only set to bool if try block succeeds requests.packages.urllib3.disable_warnings() - self._display.warning("SSL verification of %s disabled" % - self.FOREMAN_URL) - verify = False - else: # Set to a CA bundle: - verify = self.FOREMAN_SSL_VERIFY + self._display.warning( + u"SSL verification of %s disabled" % self.foreman_url, + ) + return verify - def send_facts(self, host, data): + def send_facts(self): """ Sends facts to Foreman, to be parsed by foreman_ansible fact parser. The default fact importer should import these facts properly. """ - data["_type"] = "ansible" - data["_timestamp"] = datetime.now().strftime(self.TIME_FORMAT) - facts = {"name": host, - "facts": data, - } - try: - r = requests.post(url=self.FOREMAN_URL + '/api/v2/hosts/facts', - data=json.dumps(facts), - headers=self.FOREMAN_HEADERS, - cert=self.FOREMAN_SSL_CERT, - verify=self.ssl_verify) - r.raise_for_status() - except requests.exceptions.RequestException as err: - print(to_text(err)) - - def _build_log(self, data): - logs = [] - for entry in data: - source, msg = entry - if 'failed' in msg: - level = 'err' - elif 'changed' in msg and msg['changed']: - level = 'notice' - else: - level = 'info' - logs.append({ - "log": { - 'sources': { - 'source': source - }, - 'messages': { - 'message': json.dumps(msg) - }, - 'level': level - } - }) - return logs + url = self.foreman_url + '/api/v2/hosts/facts' + + for host, facts in self.facts.items(): + facts = { + "name": host, + "facts": { + "ansible_facts": self.facts[host], + "_type": "ansible", + "_timestamp": get_now(), + }, + } + + try: + response = self.session.post(url=url, json=facts) + response.raise_for_status() + except requests.exceptions.RequestException as err: + self._display.warning(u'Sending facts to Foreman at {url} failed for {host}: {err}'.format( + host=to_text(host), err=to_text(err), url=to_text(self.foreman_url))) def send_reports(self, stats): """ @@ -204,42 +229,44 @@ def send_reports(self, stats): importer. THe data is in a format that Foreman can handle without writing another report importer. """ - status = defaultdict(lambda: 0) - metrics = {} + url = self.foreman_url + '/api/v2/config_reports' for host in stats.processed.keys(): - sum = stats.summarize(host) - status["applied"] = sum['changed'] - status["failed"] = sum['failures'] + sum['unreachable'] - status["skipped"] = sum['skipped'] - log = self._build_log(self.items[host]) - metrics["time"] = {"total": int(time.time()) - self.start_time} - now = datetime.now().strftime(self.TIME_FORMAT) + total = stats.summarize(host) report = { "config_report": { "host": host, - "reported_at": now, - "metrics": metrics, - "status": status, - "logs": log, + "reported_at": get_now(), + "metrics": { + "time": { + "total": int(get_time() - self.start_time) + } + }, + "status": { + "applied": total['changed'], + "failed": total['failures'] + total['unreachable'], + "skipped": total['skipped'], + }, + "logs": list(build_log(self.items[host])), "reporter": "ansible", } } try: - r = requests.post(url=self.FOREMAN_URL + '/api/v2/config_reports', - data=json.dumps(report), - headers=self.FOREMAN_HEADERS, - cert=self.FOREMAN_SSL_CERT, - verify=self.ssl_verify) - r.raise_for_status() + response = self.session.post(url=url, json=report) + response.raise_for_status() except requests.exceptions.RequestException as err: - print(to_text(err)) + self._display.warning(u'Sending report to Foreman at {url} failed for {host}: {err}'.format( + host=to_text(host), err=to_text(err), url=to_text(self.foreman_url))) + self.items[host] = [] def append_result(self, result): name = result._task.get_name() host = result._host.get_name() - self.items[host].append((name, result._result)) + value = result._result + self.items[host].append((name, value)) + if 'ansible_facts' in value: + self.facts[host].update(value['ansible_facts']) # Ansible callback API def v2_runner_on_failed(self, result, ignore_errors=False): @@ -248,21 +275,15 @@ def v2_runner_on_failed(self, result, ignore_errors=False): def v2_runner_on_unreachable(self, result): self.append_result(result) - def v2_runner_on_async_ok(self, result, jid): + def v2_runner_on_async_ok(self, result): self.append_result(result) - def v2_runner_on_async_failed(self, result, jid): + def v2_runner_on_async_failed(self, result): self.append_result(result) def v2_playbook_on_stats(self, stats): + self.send_facts() self.send_reports(stats) def v2_runner_on_ok(self, result): - res = result._result - module = result._task.action - - if module == 'setup' or 'ansible_facts' in res: - host = result._host.get_name() - self.send_facts(host, res) - else: - self.append_result(result) + self.append_result(result) From d5bb109595e4e7612f9e09fe10457514f8eb56ae Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Wed, 24 Mar 2021 11:17:40 +0100 Subject: [PATCH 17/56] add bmc_proxy param to subnet --- changelogs/fragments/subnet-bmc-proxy-param.yml | 2 ++ plugins/modules/subnet.py | 6 ++++++ 2 files changed, 8 insertions(+) create mode 100644 changelogs/fragments/subnet-bmc-proxy-param.yml diff --git a/changelogs/fragments/subnet-bmc-proxy-param.yml b/changelogs/fragments/subnet-bmc-proxy-param.yml new file mode 100644 index 00000000..f211c07b --- /dev/null +++ b/changelogs/fragments/subnet-bmc-proxy-param.yml @@ -0,0 +1,2 @@ +minor_changes: + - subnet - add ``bmc_proxy`` parameter to configure BMC proxies for subnets diff --git a/plugins/modules/subnet.py b/plugins/modules/subnet.py index 4936ea55..276d13e1 100644 --- a/plugins/modules/subnet.py +++ b/plugins/modules/subnet.py @@ -125,6 +125,11 @@ description: Template Smart proxy for this subnet required: false type: str + bmc_proxy: + description: BMC Smart proxy for this subnet + required: false + type: str + version_added: 2.1.0 remote_execution_proxies: description: - Remote execution Smart proxies for this subnet @@ -248,6 +253,7 @@ def main(): discovery_proxy=dict(type='entity', flat_name='discovery_id', resource_type='smart_proxies'), dns_proxy=dict(type='entity', flat_name='dns_id', resource_type='smart_proxies'), template_proxy=dict(type='entity', flat_name='template_id', resource_type='smart_proxies'), + bmc_proxy=dict(type='entity', flat_name='bmc_id', resource_type='smart_proxies'), remote_execution_proxies=dict(type='entity_list', resource_type='smart_proxies'), externalipam_proxy=dict(type='entity', flat_name='externalipam_id', resource_type='smart_proxies'), externalipam_group=dict(), From d77a0f1162142022e69110ad4cdd692c8d2c15c5 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Wed, 24 Mar 2021 11:18:42 +0100 Subject: [PATCH 18/56] clarify that subnet DNS proxies are about *reverse* DNS --- plugins/modules/subnet.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/modules/subnet.py b/plugins/modules/subnet.py index 276d13e1..39f485a8 100644 --- a/plugins/modules/subnet.py +++ b/plugins/modules/subnet.py @@ -118,7 +118,7 @@ required: false type: str dns_proxy: - description: DNS Smart proxy for this subnet + description: Reverse DNS Smart proxy for this subnet required: false type: str template_proxy: From b5c1894fea8ac5b2735dd2d93303d8b89faaa420 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Tue, 6 Apr 2021 11:54:53 +0200 Subject: [PATCH 19/56] add ansible 2.11 to test matrix --- .github/workflows/main.yml | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index ced01747..88db4e4d 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -23,6 +23,7 @@ jobs: - stable-2.8 - stable-2.9 - stable-2.10 + - stable-2.11 - devel exclude: - python: "2.7" @@ -31,24 +32,32 @@ jobs: ansible: "stable-2.9" - python: "2.7" ansible: "stable-2.10" + - python: "2.7" + ansible: "stable-2.11" - python: "3.6" ansible: "stable-2.8" - python: "3.6" ansible: "stable-2.9" - python: "3.6" ansible: "stable-2.10" + - python: "3.6" + ansible: "stable-2.11" - python: "3.8" ansible: "stable-2.8" - python: "3.8" ansible: "stable-2.9" - python: "3.8" ansible: "stable-2.10" + - python: "3.8" + ansible: "stable-2.11" - python: "3.9" ansible: "stable-2.8" - python: "3.9" ansible: "stable-2.9" - python: "3.9" ansible: "stable-2.10" + - python: "3.9" + ansible: "stable-2.11" steps: - uses: actions/checkout@v2 - name: Set up Python @@ -77,7 +86,7 @@ jobs: run: sudo mkdir -p /etc/rhsm/ca/ && sudo touch /etc/rhsm/ca/redhat-uep.pem - name: Install required collections for ansible-base (2.10+) run: ansible-galaxy collection install community.docker - if: matrix.ansible == 'devel' || matrix.ansible == 'stable-2.10' + if: matrix.ansible == 'devel' || matrix.ansible == 'stable-2.10' || matrix.ansible == 'stable-2.11' - name: Run crud tests run: make test-crud - name: Run other tests @@ -86,7 +95,7 @@ jobs: run: make dist-test - name: Run sanity tests run: make SANITY_OPTS="--local" sanity - if: matrix.ansible == 'devel' || matrix.ansible == 'stable-2.10' + if: matrix.ansible == 'devel' || matrix.ansible == 'stable-2.10' || matrix.stable == 'stable-2.11' checkmode: runs-on: ubuntu-latest From fd770936a6fd694ffb44258a4bb138569b9a315d Mon Sep 17 00:00:00 2001 From: "Eric D. Helms" Date: Tue, 22 Dec 2020 15:04:33 +0000 Subject: [PATCH 20/56] Add role for managing hostgroups --- changelogs/fragments/1116-hostgroups-role.yml | 2 + roles/hostgroups/README.md | 75 ++++++ roles/hostgroups/tasks/main.yml | 42 +++ tests/fixtures/apidoc/hostgroups_role.json | 1 + .../fixtures/hostgroups_role-0.yml | 176 ++++++++++++ .../fixtures/hostgroups_role-1.yml | 252 ++++++++++++++++++ .../fixtures/hostgroups_role-2.yml | 236 ++++++++++++++++ tests/test_playbooks/hostgroups_role.yml | 29 ++ 8 files changed, 813 insertions(+) create mode 100644 changelogs/fragments/1116-hostgroups-role.yml create mode 100644 roles/hostgroups/README.md create mode 100644 roles/hostgroups/tasks/main.yml create mode 120000 tests/fixtures/apidoc/hostgroups_role.json create mode 100644 tests/test_playbooks/fixtures/hostgroups_role-0.yml create mode 100644 tests/test_playbooks/fixtures/hostgroups_role-1.yml create mode 100644 tests/test_playbooks/fixtures/hostgroups_role-2.yml create mode 100644 tests/test_playbooks/hostgroups_role.yml diff --git a/changelogs/fragments/1116-hostgroups-role.yml b/changelogs/fragments/1116-hostgroups-role.yml new file mode 100644 index 00000000..7203e01a --- /dev/null +++ b/changelogs/fragments/1116-hostgroups-role.yml @@ -0,0 +1,2 @@ +minor_changes: + - Add a hostgroups role (https://github.com/theforeman/foreman-ansible-modules/issues/1116) diff --git a/roles/hostgroups/README.md b/roles/hostgroups/README.md new file mode 100644 index 00000000..3b1af611 --- /dev/null +++ b/roles/hostgroups/README.md @@ -0,0 +1,75 @@ +theforeman.foreman.hostgroups +============================= + +This role creates and manages Hostgroups. + +Role Variables +-------------- + +This role supports the [Common Role Variables](https://github.com/theforeman/foreman-ansible-modules/blob/develop/README.md#common-role-variables). + +- `foreman_hostgroups`: List of hostgroups to manage that are each represented as a dictionary. See module documentation for a list of available options for each hostgroup. + Hostgroups may have any set of fields defined on them and may optionally define a `parent` for nested hostgroups. + A variety of examples are demonstrated in the data structure below: + +```yaml +foreman_hostgroups: + - name: "Basic example" + architecture: "x86_64" + operatingsystem: "CentOS" + medium: "media_name" + ptable: "partition_table_name" + - name: "Proxies hostgroup" + environment: production + puppet_proxy: puppet-proxy.example.com + puppet_ca_proxy: puppet-proxy.example.com + openscap_proxy: openscap-proxy.example.com + - name: "CentOS 7" + organization: "Default Organization" + lifecycle_environment: "Production" + content_view: "CentOS 7" + activation_keys: centos-7 + - name: "Webserver" + parent: "CentOS 7" + environment: production + puppet_proxy: puppet-proxy.example.com + puppet_ca_proxy: puppet-proxy.example.com + openscap_proxy: openscap-proxy.example.com +``` + +Example Playbooks +----------------- + +This example creates several hostgroups with some nested examples. + +```yaml +- hosts: localhost + roles: + - role: theforeman.foreman.hostgroups + vars: + foreman_server_url: https://foreman.example.com + foreman_username: "admin" + foreman_password: "changeme" + foreman_hostgroups: + - name: "Basic example" + architecture: "x86_64" + operatingsystem: "CentOS" + medium: "media_name" + ptable: "partition_table_name" + - name: "Proxies hostgroup" + environment: production + puppet_proxy: puppet-proxy.example.com + puppet_ca_proxy: puppet-proxy.example.com + openscap_proxy: openscap-proxy.example.com + - name: "CentOS 7" + organization: "Default Organization" + lifecycle_environment: "Production" + content_view: "CentOS 7" + activation_keys: centos-7 + - name: "Webserver" + parent: "CentOS 7" + environment: production + puppet_proxy: puppet-proxy.example.com + puppet_ca_proxy: puppet-proxy.example.com + openscap_proxy: openscap-proxy.example.com +``` diff --git a/roles/hostgroups/tasks/main.yml b/roles/hostgroups/tasks/main.yml new file mode 100644 index 00000000..55d60d05 --- /dev/null +++ b/roles/hostgroups/tasks/main.yml @@ -0,0 +1,42 @@ +--- +- name: 'Create Hostgroups' + theforeman.foreman.hostgroup: + username: "{{ foreman_username | default(omit) }}" + password: "{{ foreman_password | default(omit) }}" + server_url: "{{ foreman_server_url | default(omit) }}" + validate_certs: "{{ validate_certs | default(omit) }}" + name: "{{ item.name }}" + updated_name: "{{ item.updated_name | default(omit) }}" + description: "{{ item.description | default(omit) }}" + parent: "{{ item.parent | default(omit) }}" + organization: "{{ item.organization | default(omit) }}" + organizations: "{{ item.organizations | default(omit) }}" + locations: "{{ item.locations | default(omit) }}" + architecture: "{{ item.architecture | default(omit) }}" + operatingsystem: "{{ item.operatingsystem | default(omit) }}" + medium: "{{ item.medium | default(omit) }}" + ptable: "{{ item.ptable | default(omit) }}" + parameters: "{{ item.parameters | default(omit) }}" + ansible_roles: "{{ item.ansible_roles | default(omit) }}" + compute_resource: "{{ item.compute_resource | default(omit) }}" + compute_profile: "{{ item.compute_profile | default(omit) }}" + domain: "{{ item.domain | default(omit) }}" + subnet: "{{ item.subnet | default(omit) }}" + subnet6: "{{ item.subnet6 | default(omit) }}" + root_pass: "{{ item.root_pass | default(omit) }}" + realm: "{{ item.realm | default(omit) }}" + pxe_loader: "{{ item.pxe_loader | default(omit) }}" + environment: "{{ item.environment | default(omit) }}" + puppetclasses: "{{ item.puppetclasses | default(omit) }}" + config_groups: "{{ item.config_groups | default(omit) }}" + puppet_proxy: "{{ item.puppet_proxy | default(omit) }}" + puppet_ca_proxy: "{{ item.puppet_ca_proxy | default(omit) }}" + openscap_proxy: "{{ item.openscap_proxy | default(omit) }}" + content_source: "{{ item.content_source | default(omit) }}" + lifecycle_environment: "{{ item.lifecycle_environment | default(omit) }}" + kickstart_repository: "{{ item.kickstart_repository | default(omit) }}" + content_view: "{{ item.content_view | default(omit) }}" + activation_keys: "{{ item.activation_keys | default(omit) }}" + state: "{{ item.state | default(omit) }}" + with_items: + - "{{ foreman_hostgroups }}" diff --git a/tests/fixtures/apidoc/hostgroups_role.json b/tests/fixtures/apidoc/hostgroups_role.json new file mode 120000 index 00000000..f9e40151 --- /dev/null +++ b/tests/fixtures/apidoc/hostgroups_role.json @@ -0,0 +1 @@ +foreman.json \ No newline at end of file diff --git a/tests/test_playbooks/fixtures/hostgroups_role-0.yml b/tests/test_playbooks/fixtures/hostgroups_role-0.yml new file mode 100644 index 00000000..b83fa367 --- /dev/null +++ b/tests/test_playbooks/fixtures/hostgroups_role-0.yml @@ -0,0 +1,176 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hostgroups?search=title%3D%22Hostgroup1%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 0,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"title=\\\"Hostgroup1\\\"\",\n \"sort\": {\n\ + \ \"by\": null,\n \"order\": null\n },\n \"results\": []\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '177' + status: + code: 200 + message: OK +- request: + body: '{"hostgroup": {"name": "Hostgroup1"}}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '37' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/api/hostgroups + response: + body: + string: '{"subnet_id":null,"subnet_name":null,"operatingsystem_id":null,"operatingsystem_name":null,"domain_id":null,"domain_name":null,"environment_id":null,"environment_name":null,"compute_profile_id":null,"compute_profile_name":null,"ancestry":null,"parent_id":null,"parent_name":null,"ptable_id":null,"ptable_name":null,"medium_id":null,"medium_name":null,"pxe_loader":null,"subnet6_id":null,"subnet6_name":null,"compute_resource_id":null,"compute_resource_name":null,"architecture_id":null,"architecture_name":null,"realm_id":null,"realm_name":null,"created_at":"2020-12-22 + 15:01:20 UTC","updated_at":"2020-12-22 15:01:20 UTC","id":1,"name":"Hostgroup1","title":"Hostgroup1","description":null,"puppet_proxy_id":null,"puppet_proxy_name":null,"puppet_ca_proxy_id":null,"puppet_ca_proxy_name":null,"puppet_proxy":null,"puppet_ca_proxy":null,"inherited_compute_profile_id":null,"inherited_environment_id":null,"inherited_domain_id":null,"inherited_puppet_proxy_id":null,"inherited_puppet_ca_proxy_id":null,"inherited_compute_resource_id":null,"inherited_operatingsystem_id":null,"inherited_architecture_id":null,"inherited_medium_id":null,"inherited_ptable_id":null,"inherited_subnet_id":null,"inherited_subnet6_id":null,"inherited_realm_id":null,"inherited_pxe_loader":null,"parameters":[],"template_combinations":[],"puppetclasses":[],"config_groups":[],"all_puppetclasses":[],"locations":[{"id":2,"name":"Default + Location","title":"Default Location","description":null}],"organizations":[]}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/test_playbooks/fixtures/hostgroups_role-1.yml b/tests/test_playbooks/fixtures/hostgroups_role-1.yml new file mode 100644 index 00000000..0231d7b3 --- /dev/null +++ b/tests/test_playbooks/fixtures/hostgroups_role-1.yml @@ -0,0 +1,252 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hostgroups?search=title%3D%22Hostgroup1%2FHostgroup2%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"title=\\\"Hostgroup1/Hostgroup2\\\"\",\n \"\ + sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": []\n\ + }\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '188' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hostgroups?search=title%3D%22Hostgroup1%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"title=\\\"Hostgroup1\\\"\",\n \"sort\": {\n\ + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"subnet_id\"\ + :null,\"subnet_name\":null,\"operatingsystem_id\":null,\"operatingsystem_name\"\ + :null,\"domain_id\":null,\"domain_name\":null,\"environment_id\":null,\"environment_name\"\ + :null,\"compute_profile_id\":null,\"compute_profile_name\":null,\"ancestry\"\ + :null,\"parent_id\":null,\"parent_name\":null,\"ptable_id\":null,\"ptable_name\"\ + :null,\"medium_id\":null,\"medium_name\":null,\"pxe_loader\":null,\"subnet6_id\"\ + :null,\"subnet6_name\":null,\"compute_resource_id\":null,\"compute_resource_name\"\ + :null,\"architecture_id\":null,\"architecture_name\":null,\"realm_id\":null,\"\ + realm_name\":null,\"created_at\":\"2020-12-22 15:01:20 UTC\",\"updated_at\"\ + :\"2020-12-22 15:01:20 UTC\",\"id\":1,\"name\":\"Hostgroup1\",\"title\":\"\ + Hostgroup1\",\"description\":null,\"puppet_proxy_id\":null,\"puppet_proxy_name\"\ + :null,\"puppet_ca_proxy_id\":null,\"puppet_ca_proxy_name\":null,\"puppet_proxy\"\ + :null,\"puppet_ca_proxy\":null,\"inherited_compute_profile_id\":null,\"inherited_environment_id\"\ + :null,\"inherited_domain_id\":null,\"inherited_puppet_proxy_id\":null,\"inherited_puppet_ca_proxy_id\"\ + :null,\"inherited_compute_resource_id\":null,\"inherited_operatingsystem_id\"\ + :null,\"inherited_architecture_id\":null,\"inherited_medium_id\":null,\"inherited_ptable_id\"\ + :null,\"inherited_subnet_id\":null,\"inherited_subnet6_id\":null,\"inherited_realm_id\"\ + :null,\"inherited_pxe_loader\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1445' + status: + code: 200 + message: OK +- request: + body: '{"hostgroup": {"name": "Hostgroup2", "parent_id": 1}}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '53' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/api/hostgroups + response: + body: + string: '{"subnet_id":null,"subnet_name":null,"operatingsystem_id":null,"operatingsystem_name":null,"domain_id":null,"domain_name":null,"environment_id":null,"environment_name":null,"compute_profile_id":null,"compute_profile_name":null,"ancestry":"1","parent_id":1,"parent_name":"Hostgroup1","ptable_id":null,"ptable_name":null,"medium_id":null,"medium_name":null,"pxe_loader":null,"subnet6_id":null,"subnet6_name":null,"compute_resource_id":null,"compute_resource_name":null,"architecture_id":null,"architecture_name":null,"realm_id":null,"realm_name":null,"created_at":"2020-12-22 + 15:01:21 UTC","updated_at":"2020-12-22 15:01:21 UTC","id":2,"name":"Hostgroup2","title":"Hostgroup1/Hostgroup2","description":null,"puppet_proxy_id":null,"puppet_proxy_name":null,"puppet_ca_proxy_id":null,"puppet_ca_proxy_name":null,"puppet_proxy":null,"puppet_ca_proxy":null,"inherited_compute_profile_id":null,"inherited_environment_id":null,"inherited_domain_id":null,"inherited_puppet_proxy_id":null,"inherited_puppet_ca_proxy_id":null,"inherited_compute_resource_id":null,"inherited_operatingsystem_id":null,"inherited_architecture_id":null,"inherited_medium_id":null,"inherited_ptable_id":null,"inherited_subnet_id":null,"inherited_subnet6_id":null,"inherited_realm_id":null,"inherited_pxe_loader":null,"parameters":[],"template_combinations":[],"puppetclasses":[],"config_groups":[],"all_puppetclasses":[],"locations":[{"id":2,"name":"Default + Location","title":"Default Location","description":null}],"organizations":[]}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/test_playbooks/fixtures/hostgroups_role-2.yml b/tests/test_playbooks/fixtures/hostgroups_role-2.yml new file mode 100644 index 00000000..77a6d555 --- /dev/null +++ b/tests/test_playbooks/fixtures/hostgroups_role-2.yml @@ -0,0 +1,236 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hostgroups?search=title%3D%22Hostgroup3%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"title=\\\"Hostgroup3\\\"\",\n \"sort\": {\n\ + \ \"by\": null,\n \"order\": null\n },\n \"results\": []\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '177' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/architectures?search=name%3D%22x86_64%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"x86_64\\\"\",\n \"sort\": {\n \ + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"created_at\"\ + :\"2020-12-10 17:44:07 UTC\",\"updated_at\":\"2020-12-10 17:44:07 UTC\",\"\ + name\":\"x86_64\",\"id\":1}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '274' + status: + code: 200 + message: OK +- request: + body: '{"hostgroup": {"name": "Hostgroup3", "architecture_id": 1}}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '59' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/api/hostgroups + response: + body: + string: '{"subnet_id":null,"subnet_name":null,"operatingsystem_id":null,"operatingsystem_name":null,"domain_id":null,"domain_name":null,"environment_id":null,"environment_name":null,"compute_profile_id":null,"compute_profile_name":null,"ancestry":null,"parent_id":null,"parent_name":null,"ptable_id":null,"ptable_name":null,"medium_id":null,"medium_name":null,"pxe_loader":null,"subnet6_id":null,"subnet6_name":null,"compute_resource_id":null,"compute_resource_name":null,"architecture_id":1,"architecture_name":"x86_64","realm_id":null,"realm_name":null,"created_at":"2020-12-22 + 15:01:22 UTC","updated_at":"2020-12-22 15:01:22 UTC","id":3,"name":"Hostgroup3","title":"Hostgroup3","description":null,"puppet_proxy_id":null,"puppet_proxy_name":null,"puppet_ca_proxy_id":null,"puppet_ca_proxy_name":null,"puppet_proxy":null,"puppet_ca_proxy":null,"inherited_compute_profile_id":null,"inherited_environment_id":null,"inherited_domain_id":null,"inherited_puppet_proxy_id":null,"inherited_puppet_ca_proxy_id":null,"inherited_compute_resource_id":null,"inherited_operatingsystem_id":null,"inherited_architecture_id":null,"inherited_medium_id":null,"inherited_ptable_id":null,"inherited_subnet_id":null,"inherited_subnet6_id":null,"inherited_realm_id":null,"inherited_pxe_loader":null,"parameters":[],"template_combinations":[],"puppetclasses":[],"config_groups":[],"all_puppetclasses":[],"locations":[{"id":2,"name":"Default + Location","title":"Default Location","description":null}],"organizations":[]}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0-develop + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/test_playbooks/hostgroups_role.yml b/tests/test_playbooks/hostgroups_role.yml new file mode 100644 index 00000000..5b45b4e0 --- /dev/null +++ b/tests/test_playbooks/hostgroups_role.yml @@ -0,0 +1,29 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: ensure test organization + include_tasks: tasks/organization.yml + vars: + organization_name: "Test Organization" + organization_state: "present" + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + roles: + - role: hostgroups + vars: + foreman_hostgroups: + - name: Hostgroup1 + - name: Hostgroup2 + parent: Hostgroup1 + - name: Hostgroup3 + architecture: "x86_64" From de527d2f2bf1ef11d0fcc3ebbcb48ffe3f39a962 Mon Sep 17 00:00:00 2001 From: William Bradford Clark Date: Wed, 31 Mar 2021 11:04:00 -0400 Subject: [PATCH 21/56] Document installation from source git repository Closes #1018 --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index 1444ac09..89c7c51e 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,46 @@ The collection is also available as `ansible-collection-theforeman-foreman` from After installing the RPM, you can use the modules in the same way as when they are installed directly from Ansible Galaxy. +## Installation From Source + +For development or testing purposes, you can install the collection from source git repository. For production usage, see the instructions above on installing the latest stable release. + +### Installation from Github Repository + +With Ansible >= 2.10, you can install from a Github repository (such as this one or your fork): + +`ansible-galaxy collection install git+https://github.com/theforeman/foreman-ansible-modules.git` + +If you have configured GitHub to use SSH instead of HTTPS, you can do: + +`ansible-galaxy collection install git@github.com/theforeman/foreman-ansible-modules.git` + +You can also specify a branch to use such as `devel` (below) or a feature branch that you are working with: + +`ansible-galaxy collection install git+https://github.com/theforeman/foreman-ansible-modules.git,devel` + +To install from a `requirements.yml` file (useful when installing multiple collections) add a snippet to your `requirements.yml` like + +```yml +--- +collections: + - name: https://github.com/theforeman/foreman-ansible-modules.git + type: git + version: devel +``` + +And install all specified requirements with `ansible-galaxy install -r requirements.yml` + +### Building and Installing the Collection Locally + +For all currently supported versions of Ansible (i.e. Ansible >= 2.8, and particularly Ansible < 2.10 where the above approach is not yet supported), you can build the collection locally: + +`make dist` + +And install it with: + +`ansible-galaxy collection install ./theforeman-foreman-*.tar.gz` + ## Dependencies These dependencies are required for the Ansible controller, not the Foreman server. From b9410ff987bf5d7dd9250c2a688a9ea201da625a Mon Sep 17 00:00:00 2001 From: Baptiste Agasse Date: Fri, 9 Apr 2021 10:12:44 +0200 Subject: [PATCH 22/56] Update testing docs (#1196) --- docs/testing.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/testing.md b/docs/testing.md index 97c7b41e..62a38f54 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -76,7 +76,6 @@ $ make sanity ## Writing tests The tests in this repository run playbooks that can be found in `tests/test_playbooks`. -To be run, the name of the corresponding playbook must be listed in `tests/test_crud.py`. The playbooks should be self contained, target the features of a specific module and be able to run against an actual foreman instance. The structure would usually be something like setup -> run tests -> clean up. From 9a87cdcfbbca527c0c574f6df90ed155afa2328a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 13 Apr 2021 05:23:45 +0000 Subject: [PATCH 23/56] Bump actions/cache from v2.1.4 to v2.1.5 Bumps [actions/cache](https://github.com/actions/cache) from v2.1.4 to v2.1.5. - [Release notes](https://github.com/actions/cache/releases) - [Commits](https://github.com/actions/cache/compare/v2.1.4...1a9e2138d905efd099035b49d8b7a3888c653ca8) Signed-off-by: dependabot[bot] --- .github/workflows/main.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 88db4e4d..13a92425 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -65,7 +65,7 @@ jobs: with: python-version: ${{ matrix.python }} - name: Restore pip cache - uses: actions/cache@v2.1.4 + uses: actions/cache@v2.1.5 with: path: ~/.cache/pip key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }} @@ -106,7 +106,7 @@ jobs: with: python-version: "3.7" - name: Restore pip cache - uses: actions/cache@v2.1.4 + uses: actions/cache@v2.1.5 with: path: ~/.cache/pip key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }} @@ -128,7 +128,7 @@ jobs: with: python-version: "3.7" - name: Restore pip cache - uses: actions/cache@v2.1.4 + uses: actions/cache@v2.1.5 with: path: ~/.cache/pip key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }} @@ -153,7 +153,7 @@ jobs: with: python-version: "3.7" - name: Restore pip cache - uses: actions/cache@v2.1.4 + uses: actions/cache@v2.1.5 with: path: ~/.cache/pip key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements*.txt') }} From 8f61e1c74543044b633d657e7bd7416261649990 Mon Sep 17 00:00:00 2001 From: William Bradford Clark Date: Mon, 12 Apr 2021 16:17:53 -0400 Subject: [PATCH 24/56] content_rhel role: add products to sync plan only when enabled --- roles/content_rhel/tasks/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/roles/content_rhel/tasks/main.yml b/roles/content_rhel/tasks/main.yml index 79d7a2bf..b8320159 100644 --- a/roles/content_rhel/tasks/main.yml +++ b/roles/content_rhel/tasks/main.yml @@ -64,8 +64,8 @@ cron_expression: "{{ foreman_sync_plan_cron_expression | default(omit) }}" sync_date: "{{ foreman_sync_plan_sync_date | default('2020-01-01 00:00:00 UTC') }}" products: - - Red Hat Enterprise Linux Server - - Red Hat Enterprise Linux for x86_64 + - "{{ foreman_content_rhel_enable_rhel7 | ternary('Red Hat Enterprise Linux Server', omit) }}" + - "{{ foreman_content_rhel_enable_rhel8 | ternary('Red Hat Enterprise Linux for x86_64', omit) }}" - name: "Create Activation Key" include_role: From ea767b13089bc83fa345d1301cbff736371801f7 Mon Sep 17 00:00:00 2001 From: William Bradford Clark Date: Tue, 13 Apr 2021 10:27:48 -0400 Subject: [PATCH 25/56] content_rhel role: add products to sync plan only when enabled this corrects the implementation of 8f61e1 --- roles/content_rhel/tasks/main.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/roles/content_rhel/tasks/main.yml b/roles/content_rhel/tasks/main.yml index b8320159..76f6b0b7 100644 --- a/roles/content_rhel/tasks/main.yml +++ b/roles/content_rhel/tasks/main.yml @@ -64,8 +64,10 @@ cron_expression: "{{ foreman_sync_plan_cron_expression | default(omit) }}" sync_date: "{{ foreman_sync_plan_sync_date | default('2020-01-01 00:00:00 UTC') }}" products: - - "{{ foreman_content_rhel_enable_rhel7 | ternary('Red Hat Enterprise Linux Server', omit) }}" - - "{{ foreman_content_rhel_enable_rhel8 | ternary('Red Hat Enterprise Linux for x86_64', omit) }}" + "{{ [ + foreman_content_rhel_enable_rhel7 | ternary('Red Hat Enterprise Linux Server', ''), + foreman_content_rhel_enable_rhel8 | ternary('Red Hat Enterprise Linux for x86_64', '') + ] | select() | list }}" - name: "Create Activation Key" include_role: From 00455f4acf63983a2b53f24c81b336949f0f1482 Mon Sep 17 00:00:00 2001 From: Baptiste Agasse Date: Thu, 8 Apr 2021 20:45:22 +0200 Subject: [PATCH 26/56] Add content_credentials role --- .../1196-content_credentials-role.yml | 2 + roles/content_credentials/README.md | 107 ++++++++ roles/content_credentials/tasks/main.yml | 12 + .../apidoc/content_credentials_role.json | 1 + .../content_credentials_role.yml | 59 +++++ .../fixtures/content_credentials_role-0.yml | 242 ++++++++++++++++++ .../fixtures/content_credentials_role-1.yml | 242 ++++++++++++++++++ 7 files changed, 665 insertions(+) create mode 100644 changelogs/fragments/1196-content_credentials-role.yml create mode 100644 roles/content_credentials/README.md create mode 100644 roles/content_credentials/tasks/main.yml create mode 120000 tests/fixtures/apidoc/content_credentials_role.json create mode 100644 tests/test_playbooks/content_credentials_role.yml create mode 100644 tests/test_playbooks/fixtures/content_credentials_role-0.yml create mode 100644 tests/test_playbooks/fixtures/content_credentials_role-1.yml diff --git a/changelogs/fragments/1196-content_credentials-role.yml b/changelogs/fragments/1196-content_credentials-role.yml new file mode 100644 index 00000000..61a612d3 --- /dev/null +++ b/changelogs/fragments/1196-content_credentials-role.yml @@ -0,0 +1,2 @@ +minor_changes: + - Add content credentials role diff --git a/roles/content_credentials/README.md b/roles/content_credentials/README.md new file mode 100644 index 00000000..6f2f68d4 --- /dev/null +++ b/roles/content_credentials/README.md @@ -0,0 +1,107 @@ +theforeman.foreman.content_credentials +======================================= + +This role defines Content Credentials. + +Role Variables +-------------- + +This role supports the [Common Role Variables](https://github.com/theforeman/foreman-ansible-modules/blob/develop/README.md#common-role-variables). + +- `foreman_content_credentials`: List of content credentials to create. Each content credential is represented as a dictionary which specifies the `name`, `content_type` (which can be `gpg_key` or `cert`) and `content` of the content credential. + +```yaml +foreman_content_credentials: + - name: RPM-GPG-KEY-foreman + content_type: gpg_key + content: "{{ lookup('url', 'https://yum.theforeman.org/releases/latest/RPM-GPG-KEY-foreman', split_lines=False) }}" + - name: RPM-GPG-KEY-my-repo + content_type: gpg_key + content: "{{ lookup('file', '/etc/pki/rpm-gpg/RPM-GPG-KEY-my-repo') }}" + - name: RPM-GPG-KEY-my-repo2 + content_type: gpg_key + content: | + -----BEGIN PGP PUBLIC KEY BLOCK----- + mQINBGAX2bIBEADuTGNExTEST0hOcpJ13XS1BEwuhzo7r16QaI0hP1vRxZeLJgeC + b2KWRvHHfepr2jdAoAeOVhERrMz5EpMcgPEs7NUE+vbYr+K9LFzw5gmUC00CCuQ+ + RCJRRXYNV8F41y4dTGOkE/ON52ljDvVyFb3DbUUYPH9ZfOE0Z6kMIcJo6eYsDAdK + EjoQ1jQkVaRa8I4+YZ9XEFkPqVUkY1+tMfipqqQuNbvN2xgQSk8dc6uEouyC8FBA + GPugplbCaEZNFWt48xQU9vP1JblQ6z9cynLKFxxWkgr9DKRRh1kw2pIQyGhl1RhI + uvedY9OeJlqxuBsBvko7JULcX622HcHUkhzQD+ss0L9nE3lZuO5ywpZdTYln296E + 7awNEr0ER9Xqx9pMp5JeXNSHjlleFN01vLG5Xa7WNc32fvDtn2JhkzTU/dlIA2F+ + w5Tlg5ROY8olWc+jHKmvTQwxZ9s9XQuHmBpNbOijHg4Ekr0TGo6d3rjHZKiisZBG + mAbHe1pWLOmeRpjqc6xmIpDMrsx75U0WgkwjBtbfxUcDYEzzJOcO87Q3s8kH+ie3 + 5eSClT7coImWUmVKIoFSvxj8JgUT6P81v7CW4AlVDpRjBtYmc82NsGuSEgAykuQo + VRguqU/w3QTU3rEcWfLVmyfyEKC4tBUCAhGShii/rLrtCspBT+uVpcDkQwARAQAB + tD1Gb3JlbWFuIEF1dG9tYXRpYyBTaWduaW5nIEtleSAoMi40KSA8cGFja2FnZXNA + dGhlZm9yZW1hbi5vcmc+iQJUBBMBCAA+FiEEZDJT9xuCsb6vLh1PpDm9Vawq2fEF + AmAX2bICGy8FCQHhM4AFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQpDm9Vawq + 2fHMBQ//ffbTmU0Bl9Im8dDCzebhO6/D3iyshoceAfUjJrwvuhzSlil2cjWiLdmP + CjBhUB8eDRhSQ+LlfJe9C0PKEyC72rzTsfUZj4NBKNQGT2P+peJ1l8PUAAlk7jZl + QZcDER9Nju7/d+VTqF6PXkcbnIo1GVD/EX+R9mKphIbu9qaxBqGhCVay1D7jNxzH + OBaMse5hf1hJ0WzcyK6pRLMU9JeuLEdhwJqSP0+/E8R31El92EO1+selLy6hD3ro + NX3iehtcQVKdQ/5rflP6K7ZbDDj76lgRBbOY+UT1tft1nvdgKIoRPMqlBc2tMLNT + jzJrw/AW7C9pRUTvox2uFKw0Eo/0pnSR4qllBCGE67VpJLXeMQFjwOLcaKX57civ + X1z7nGTg4K+Ye5BM33Pq0Df24M0qLeqD6vLhB0Ny2JFiivw4zWJu448RELb1Omai + aNipdHQDN8D345mjctUDcc/2T7q6bcu5ErrFT8GK/FPdwpgDIPN20gxEMR9vG83n + AMkzSNrMefNlJoyTdgthokPb99LmN6Foybk6VNoKy4u/mID6uprWGMIl1/LX2wu1 + xRxRy1YznHnmtGqTYOikyAp0e+4tDfHMZ58yC9/XGztxJvj6vvwwf9n5ZO4MC4Kj + XQVHErcrTa8cZWW87pLrNvILegPA6v778BV0GLV5PqnWhl9Y1sY= + =SrzP + -----END PGP PUBLIC KEY BLOCK----- + +``` + +Example Playbooks +----------------- + +Create two content credentials: + +```yaml +- hosts: localhost + roles: + - role: theforeman.foreman.content_credentials + vars: + foreman_server_url: https://foreman.example.com + foreman_username: "admin" + foreman_password: "changeme" + foreman_organization: "Default Organization" + foreman_content_credentials: + - name: RPM-GPG-KEY-foreman + content_type: gpg_key + content: "{{ lookup('url', 'https://yum.theforeman.org/releases/latest/RPM-GPG-KEY-foreman', split_lines=False) }}" + - name: RPM-GPG-KEY-my-repo + content_type: gpg_key + content: "{{ lookup('file', '/etc/pki/rpm-gpg/RPM-GPG-KEY-my-repo') }}" + - name: RPM-GPG-KEY-my-repo2 + content_type: gpg_key + content: | + -----BEGIN PGP PUBLIC KEY BLOCK----- + mQINBGAX2bIBEADuTGNExTEST0hOcpJ13XS1BEwuhzo7r16QaI0hP1vRxZeLJgeC + b2KWRvHHfepr2jdAoAeOVhERrMz5EpMcgPEs7NUE+vbYr+K9LFzw5gmUC00CCuQ+ + RCJRRXYNV8F41y4dTGOkE/ON52ljDvVyFb3DbUUYPH9ZfOE0Z6kMIcJo6eYsDAdK + EjoQ1jQkVaRa8I4+YZ9XEFkPqVUkY1+tMfipqqQuNbvN2xgQSk8dc6uEouyC8FBA + GPugplbCaEZNFWt48xQU9vP1JblQ6z9cynLKFxxWkgr9DKRRh1kw2pIQyGhl1RhI + uvedY9OeJlqxuBsBvko7JULcX622HcHUkhzQD+ss0L9nE3lZuO5ywpZdTYln296E + 7awNEr0ER9Xqx9pMp5JeXNSHjlleFN01vLG5Xa7WNc32fvDtn2JhkzTU/dlIA2F+ + w5Tlg5ROY8olWc+jHKmvTQwxZ9s9XQuHmBpNbOijHg4Ekr0TGo6d3rjHZKiisZBG + mAbHe1pWLOmeRpjqc6xmIpDMrsx75U0WgkwjBtbfxUcDYEzzJOcO87Q3s8kH+ie3 + 5eSClT7coImWUmVKIoFSvxj8JgUT6P81v7CW4AlVDpRjBtYmc82NsGuSEgAykuQo + VRguqU/w3QTU3rEcWfLVmyfyEKC4tBUCAhGShii/rLrtCspBT+uVpcDkQwARAQAB + tD1Gb3JlbWFuIEF1dG9tYXRpYyBTaWduaW5nIEtleSAoMi40KSA8cGFja2FnZXNA + dGhlZm9yZW1hbi5vcmc+iQJUBBMBCAA+FiEEZDJT9xuCsb6vLh1PpDm9Vawq2fEF + AmAX2bICGy8FCQHhM4AFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQpDm9Vawq + 2fHMBQ//ffbTmU0Bl9Im8dDCzebhO6/D3iyshoceAfUjJrwvuhzSlil2cjWiLdmP + CjBhUB8eDRhSQ+LlfJe9C0PKEyC72rzTsfUZj4NBKNQGT2P+peJ1l8PUAAlk7jZl + QZcDER9Nju7/d+VTqF6PXkcbnIo1GVD/EX+R9mKphIbu9qaxBqGhCVay1D7jNxzH + OBaMse5hf1hJ0WzcyK6pRLMU9JeuLEdhwJqSP0+/E8R31El92EO1+selLy6hD3ro + NX3iehtcQVKdQ/5rflP6K7ZbDDj76lgRBbOY+UT1tft1nvdgKIoRPMqlBc2tMLNT + jzJrw/AW7C9pRUTvox2uFKw0Eo/0pnSR4qllBCGE67VpJLXeMQFjwOLcaKX57civ + X1z7nGTg4K+Ye5BM33Pq0Df24M0qLeqD6vLhB0Ny2JFiivw4zWJu448RELb1Omai + aNipdHQDN8D345mjctUDcc/2T7q6bcu5ErrFT8GK/FPdwpgDIPN20gxEMR9vG83n + AMkzSNrMefNlJoyTdgthokPb99LmN6Foybk6VNoKy4u/mID6uprWGMIl1/LX2wu1 + xRxRy1YznHnmtGqTYOikyAp0e+4tDfHMZ58yC9/XGztxJvj6vvwwf9n5ZO4MC4Kj + XQVHErcrTa8cZWW87pLrNvILegPA6v778BV0GLV5PqnWhl9Y1sY= + =SrzP + -----END PGP PUBLIC KEY BLOCK----- +``` diff --git a/roles/content_credentials/tasks/main.yml b/roles/content_credentials/tasks/main.yml new file mode 100644 index 00000000..8cce34ae --- /dev/null +++ b/roles/content_credentials/tasks/main.yml @@ -0,0 +1,12 @@ +--- +- name: 'Create Content Crendentials' + theforeman.foreman.content_credential: + username: "{{ foreman_username | default(omit) }}" + password: "{{ foreman_password | default(omit) }}" + server_url: "{{ foreman_server_url | default(omit) }}" + validate_certs: "{{ foreman_validate_certs | default(omit) }}" + organization: "{{ foreman_organization }}" + name: "{{ item.name }}" + content_type: "{{ item.content_type }}" + content: "{{ item.content }}" + with_items: "{{ foreman_content_credentials | default([]) }}" diff --git a/tests/fixtures/apidoc/content_credentials_role.json b/tests/fixtures/apidoc/content_credentials_role.json new file mode 120000 index 00000000..8e89899a --- /dev/null +++ b/tests/fixtures/apidoc/content_credentials_role.json @@ -0,0 +1 @@ +katello.json \ No newline at end of file diff --git a/tests/test_playbooks/content_credentials_role.yml b/tests/test_playbooks/content_credentials_role.yml new file mode 100644 index 00000000..536974af --- /dev/null +++ b/tests/test_playbooks/content_credentials_role.yml @@ -0,0 +1,59 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: ensure test organization + include_tasks: tasks/organization.yml + vars: + organization_name: "Test Organization" + organization_state: "present" + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + roles: + - role: content_credentials + vars: + foreman_organization: "Test Organization" + foreman_content_credentials: + - name: RPM-GPG-KEY-foreman + content_type: gpg_key + content: "{{ lookup('url', 'https://yum.theforeman.org/releases/latest/RPM-GPG-KEY-foreman', split_lines=False) }}" + - name: RPM-GPG-KEY-my-repo2 + content_type: gpg_key + content: | + -----BEGIN PGP PUBLIC KEY BLOCK----- + mQINBGAX2bIBEADuTGNExTEST0hOcpJ13XS1BEwuhzo7r16QaI0hP1vRxZeLJgeC + b2KWRvHHfepr2jdAoAeOVhERrMz5EpMcgPEs7NUE+vbYr+K9LFzw5gmUC00CCuQ+ + RCJRRXYNV8F41y4dTGOkE/ON52ljDvVyFb3DbUUYPH9ZfOE0Z6kMIcJo6eYsDAdK + EjoQ1jQkVaRa8I4+YZ9XEFkPqVUkY1+tMfipqqQuNbvN2xgQSk8dc6uEouyC8FBA + GPugplbCaEZNFWt48xQU9vP1JblQ6z9cynLKFxxWkgr9DKRRh1kw2pIQyGhl1RhI + uvedY9OeJlqxuBsBvko7JULcX622HcHUkhzQD+ss0L9nE3lZuO5ywpZdTYln296E + 7awNEr0ER9Xqx9pMp5JeXNSHjlleFN01vLG5Xa7WNc32fvDtn2JhkzTU/dlIA2F+ + w5Tlg5ROY8olWc+jHKmvTQwxZ9s9XQuHmBpNbOijHg4Ekr0TGo6d3rjHZKiisZBG + mAbHe1pWLOmeRpjqc6xmIpDMrsx75U0WgkwjBtbfxUcDYEzzJOcO87Q3s8kH+ie3 + 5eSClT7coImWUmVKIoFSvxj8JgUT6P81v7CW4AlVDpRjBtYmc82NsGuSEgAykuQo + VRguqU/w3QTU3rEcWfLVmyfyEKC4tBUCAhGShii/rLrtCspBT+uVpcDkQwARAQAB + tD1Gb3JlbWFuIEF1dG9tYXRpYyBTaWduaW5nIEtleSAoMi40KSA8cGFja2FnZXNA + dGhlZm9yZW1hbi5vcmc+iQJUBBMBCAA+FiEEZDJT9xuCsb6vLh1PpDm9Vawq2fEF + AmAX2bICGy8FCQHhM4AFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQpDm9Vawq + 2fHMBQ//ffbTmU0Bl9Im8dDCzebhO6/D3iyshoceAfUjJrwvuhzSlil2cjWiLdmP + CjBhUB8eDRhSQ+LlfJe9C0PKEyC72rzTsfUZj4NBKNQGT2P+peJ1l8PUAAlk7jZl + QZcDER9Nju7/d+VTqF6PXkcbnIo1GVD/EX+R9mKphIbu9qaxBqGhCVay1D7jNxzH + OBaMse5hf1hJ0WzcyK6pRLMU9JeuLEdhwJqSP0+/E8R31El92EO1+selLy6hD3ro + NX3iehtcQVKdQ/5rflP6K7ZbDDj76lgRBbOY+UT1tft1nvdgKIoRPMqlBc2tMLNT + jzJrw/AW7C9pRUTvox2uFKw0Eo/0pnSR4qllBCGE67VpJLXeMQFjwOLcaKX57civ + X1z7nGTg4K+Ye5BM33Pq0Df24M0qLeqD6vLhB0Ny2JFiivw4zWJu448RELb1Omai + aNipdHQDN8D345mjctUDcc/2T7q6bcu5ErrFT8GK/FPdwpgDIPN20gxEMR9vG83n + AMkzSNrMefNlJoyTdgthokPb99LmN6Foybk6VNoKy4u/mID6uprWGMIl1/LX2wu1 + xRxRy1YznHnmtGqTYOikyAp0e+4tDfHMZ58yC9/XGztxJvj6vvwwf9n5ZO4MC4Kj + XQVHErcrTa8cZWW87pLrNvILegPA6v778BV0GLV5PqnWhl9Y1sY= + =SrzP + -----END PGP PUBLIC KEY BLOCK----- diff --git a/tests/test_playbooks/fixtures/content_credentials_role-0.yml b/tests/test_playbooks/fixtures/content_credentials_role-0.yml new file mode 100644 index 00000000..3346bf1f --- /dev/null +++ b/tests/test_playbooks/fixtures/content_credentials_role-0.yml @@ -0,0 +1,242 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2021-04-08 + 18:31:57 UTC\",\"updated_at\":\"2021-04-08 18:31:57 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_credentials?organization_id=3&search=name%3D%22RPM-GPG-KEY-foreman%22&per_page=4294967296 + response: + body: + string: '{"total":0,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"RPM-GPG-KEY-foreman\"","sort":{"by":"name","order":"asc"},"results":[]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '159' + status: + code: 200 + message: OK +- request: + body: '{"organization_id": 3, "name": "RPM-GPG-KEY-foreman", "content_type": "gpg_key", + "content": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmQINBGAX2bIBEADuTGNExTEST0hOcpJ13XS1BEwuhzo7r16QaI0hP1vRxZeLJgeC\nb2KWRvHHfepr2jdAoAeOVhERrMz5EpMcgPEs7NUE+vbYr+K9LFzw5gmUC00CCuQ+\nRCJRRXYNV8F41y4dTGOkE/ON52ljDvVyFb3DbUUYPH9ZfOE0Z6kMIcJo6eYsDAdK\nEjoQ1jQkVaRa8I4+YZ9XEFkPqVUkY1+tMfipqqQuNbvN2xgQSk8dc6uEouyC8FBA\nGPugplbCaEZNFWt48xQU9vP1JblQ6z9cynLKFxxWkgr9DKRRh1kw2pIQyGhl1RhI\nuvedY9OeJlqxuBsBvko7JULcX622HcHUkhzQD+ss0L9nE3lZuO5ywpZdTYln296E\n7awNEr0ER9Xqx9pMp5JeXNSHjlleFN01vLG5Xa7WNc32fvDtn2JhkzTU/dlIA2F+\nw5Tlg5ROY8olWc+jHKmvTQwxZ9s9XQuHmBpNbOijHg4Ekr0TGo6d3rjHZKiisZBG\nmAbHe1pWLOmeRpjqc6xmIpDMrsx75U0WgkwjBtbfxUcDYEzzJOcO87Q3s8kH+ie3\n5eSClT7coImWUmVKIoFSvxj8JgUT6P81v7CW4AlVDpRjBtYmc82NsGuSEgAykuQo\nVRguqU/w3QTU3rEcWfLVmyfyEKC4tBUCAhGShii/rLrtCspBT+uVpcDkQwARAQAB\ntD1Gb3JlbWFuIEF1dG9tYXRpYyBTaWduaW5nIEtleSAoMi40KSA8cGFja2FnZXNA\ndGhlZm9yZW1hbi5vcmc+iQJUBBMBCAA+FiEEZDJT9xuCsb6vLh1PpDm9Vawq2fEF\nAmAX2bICGy8FCQHhM4AFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQpDm9Vawq\n2fHMBQ//ffbTmU0Bl9Im8dDCzebhO6/D3iyshoceAfUjJrwvuhzSlil2cjWiLdmP\nCjBhUB8eDRhSQ+LlfJe9C0PKEyC72rzTsfUZj4NBKNQGT2P+peJ1l8PUAAlk7jZl\nQZcDER9Nju7/d+VTqF6PXkcbnIo1GVD/EX+R9mKphIbu9qaxBqGhCVay1D7jNxzH\nOBaMse5hf1hJ0WzcyK6pRLMU9JeuLEdhwJqSP0+/E8R31El92EO1+selLy6hD3ro\nNX3iehtcQVKdQ/5rflP6K7ZbDDj76lgRBbOY+UT1tft1nvdgKIoRPMqlBc2tMLNT\njzJrw/AW7C9pRUTvox2uFKw0Eo/0pnSR4qllBCGE67VpJLXeMQFjwOLcaKX57civ\nX1z7nGTg4K+Ye5BM33Pq0Df24M0qLeqD6vLhB0Ny2JFiivw4zWJu448RELb1Omai\naNipdHQDN8D345mjctUDcc/2T7q6bcu5ErrFT8GK/FPdwpgDIPN20gxEMR9vG83n\nAMkzSNrMefNlJoyTdgthokPb99LmN6Foybk6VNoKy4u/mID6uprWGMIl1/LX2wu1\nxRxRy1YznHnmtGqTYOikyAp0e+4tDfHMZ58yC9/XGztxJvj6vvwwf9n5ZO4MC4Kj\nXQVHErcrTa8cZWW87pLrNvILegPA6v778BV0GLV5PqnWhl9Y1sY=\n=SrzP\n-----END + PGP PUBLIC KEY BLOCK-----\n"}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '1816' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/content_credentials + response: + body: + string: ' {"name":"RPM-GPG-KEY-foreman","content_type":"gpg_key","content":"-----BEGIN + PGP PUBLIC KEY BLOCK-----\n\nmQINBGAX2bIBEADuTGNExTEST0hOcpJ13XS1BEwuhzo7r16QaI0hP1vRxZeLJgeC\nb2KWRvHHfepr2jdAoAeOVhERrMz5EpMcgPEs7NUE+vbYr+K9LFzw5gmUC00CCuQ+\nRCJRRXYNV8F41y4dTGOkE/ON52ljDvVyFb3DbUUYPH9ZfOE0Z6kMIcJo6eYsDAdK\nEjoQ1jQkVaRa8I4+YZ9XEFkPqVUkY1+tMfipqqQuNbvN2xgQSk8dc6uEouyC8FBA\nGPugplbCaEZNFWt48xQU9vP1JblQ6z9cynLKFxxWkgr9DKRRh1kw2pIQyGhl1RhI\nuvedY9OeJlqxuBsBvko7JULcX622HcHUkhzQD+ss0L9nE3lZuO5ywpZdTYln296E\n7awNEr0ER9Xqx9pMp5JeXNSHjlleFN01vLG5Xa7WNc32fvDtn2JhkzTU/dlIA2F+\nw5Tlg5ROY8olWc+jHKmvTQwxZ9s9XQuHmBpNbOijHg4Ekr0TGo6d3rjHZKiisZBG\nmAbHe1pWLOmeRpjqc6xmIpDMrsx75U0WgkwjBtbfxUcDYEzzJOcO87Q3s8kH+ie3\n5eSClT7coImWUmVKIoFSvxj8JgUT6P81v7CW4AlVDpRjBtYmc82NsGuSEgAykuQo\nVRguqU/w3QTU3rEcWfLVmyfyEKC4tBUCAhGShii/rLrtCspBT+uVpcDkQwARAQAB\ntD1Gb3JlbWFuIEF1dG9tYXRpYyBTaWduaW5nIEtleSAoMi40KSA8cGFja2FnZXNA\ndGhlZm9yZW1hbi5vcmc+iQJUBBMBCAA+FiEEZDJT9xuCsb6vLh1PpDm9Vawq2fEF\nAmAX2bICGy8FCQHhM4AFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQpDm9Vawq\n2fHMBQ//ffbTmU0Bl9Im8dDCzebhO6/D3iyshoceAfUjJrwvuhzSlil2cjWiLdmP\nCjBhUB8eDRhSQ+LlfJe9C0PKEyC72rzTsfUZj4NBKNQGT2P+peJ1l8PUAAlk7jZl\nQZcDER9Nju7/d+VTqF6PXkcbnIo1GVD/EX+R9mKphIbu9qaxBqGhCVay1D7jNxzH\nOBaMse5hf1hJ0WzcyK6pRLMU9JeuLEdhwJqSP0+/E8R31El92EO1+selLy6hD3ro\nNX3iehtcQVKdQ/5rflP6K7ZbDDj76lgRBbOY+UT1tft1nvdgKIoRPMqlBc2tMLNT\njzJrw/AW7C9pRUTvox2uFKw0Eo/0pnSR4qllBCGE67VpJLXeMQFjwOLcaKX57civ\nX1z7nGTg4K+Ye5BM33Pq0Df24M0qLeqD6vLhB0Ny2JFiivw4zWJu448RELb1Omai\naNipdHQDN8D345mjctUDcc/2T7q6bcu5ErrFT8GK/FPdwpgDIPN20gxEMR9vG83n\nAMkzSNrMefNlJoyTdgthokPb99LmN6Foybk6VNoKy4u/mID6uprWGMIl1/LX2wu1\nxRxRy1YznHnmtGqTYOikyAp0e+4tDfHMZ58yC9/XGztxJvj6vvwwf9n5ZO4MC4Kj\nXQVHErcrTa8cZWW87pLrNvILegPA6v778BV0GLV5PqnWhl9Y1sY=\n=SrzP\n-----END + PGP PUBLIC KEY BLOCK-----\n","id":8,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2021-04-08 + 18:48:47 UTC","updated_at":"2021-04-08 18:48:47 UTC","gpg_key_products":[],"gpg_key_repos":[],"ssl_ca_products":[],"ssl_ca_root_repos":[],"ssl_client_products":[],"ssl_client_root_repos":[],"ssl_key_products":[],"ssl_key_root_repos":[],"permissions":{"view_content_credenials":true,"edit_content_credenials":true,"destroy_content_credenials":true}} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/test_playbooks/fixtures/content_credentials_role-1.yml b/tests/test_playbooks/fixtures/content_credentials_role-1.yml new file mode 100644 index 00000000..67dfb0e1 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_credentials_role-1.yml @@ -0,0 +1,242 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\": + {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\":\"Test_Organization\",\"created_at\":\"2021-04-08 + 18:31:57 UTC\",\"updated_at\":\"2021-04-08 18:31:57 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_credentials?organization_id=3&search=name%3D%22RPM-GPG-KEY-my-repo2%22&per_page=4294967296 + response: + body: + string: '{"total":1,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"RPM-GPG-KEY-my-repo2\"","sort":{"by":"name","order":"asc"},"results":[]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '160' + status: + code: 200 + message: OK +- request: + body: '{"organization_id": 3, "name": "RPM-GPG-KEY-my-repo2", "content_type": + "gpg_key", "content": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nmQINBGAX2bIBEADuTGNExTEST0hOcpJ13XS1BEwuhzo7r16QaI0hP1vRxZeLJgeC\nb2KWRvHHfepr2jdAoAeOVhERrMz5EpMcgPEs7NUE+vbYr+K9LFzw5gmUC00CCuQ+\nRCJRRXYNV8F41y4dTGOkE/ON52ljDvVyFb3DbUUYPH9ZfOE0Z6kMIcJo6eYsDAdK\nEjoQ1jQkVaRa8I4+YZ9XEFkPqVUkY1+tMfipqqQuNbvN2xgQSk8dc6uEouyC8FBA\nGPugplbCaEZNFWt48xQU9vP1JblQ6z9cynLKFxxWkgr9DKRRh1kw2pIQyGhl1RhI\nuvedY9OeJlqxuBsBvko7JULcX622HcHUkhzQD+ss0L9nE3lZuO5ywpZdTYln296E\n7awNEr0ER9Xqx9pMp5JeXNSHjlleFN01vLG5Xa7WNc32fvDtn2JhkzTU/dlIA2F+\nw5Tlg5ROY8olWc+jHKmvTQwxZ9s9XQuHmBpNbOijHg4Ekr0TGo6d3rjHZKiisZBG\nmAbHe1pWLOmeRpjqc6xmIpDMrsx75U0WgkwjBtbfxUcDYEzzJOcO87Q3s8kH+ie3\n5eSClT7coImWUmVKIoFSvxj8JgUT6P81v7CW4AlVDpRjBtYmc82NsGuSEgAykuQo\nVRguqU/w3QTU3rEcWfLVmyfyEKC4tBUCAhGShii/rLrtCspBT+uVpcDkQwARAQAB\ntD1Gb3JlbWFuIEF1dG9tYXRpYyBTaWduaW5nIEtleSAoMi40KSA8cGFja2FnZXNA\ndGhlZm9yZW1hbi5vcmc+iQJUBBMBCAA+FiEEZDJT9xuCsb6vLh1PpDm9Vawq2fEF\nAmAX2bICGy8FCQHhM4AFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQpDm9Vawq\n2fHMBQ//ffbTmU0Bl9Im8dDCzebhO6/D3iyshoceAfUjJrwvuhzSlil2cjWiLdmP\nCjBhUB8eDRhSQ+LlfJe9C0PKEyC72rzTsfUZj4NBKNQGT2P+peJ1l8PUAAlk7jZl\nQZcDER9Nju7/d+VTqF6PXkcbnIo1GVD/EX+R9mKphIbu9qaxBqGhCVay1D7jNxzH\nOBaMse5hf1hJ0WzcyK6pRLMU9JeuLEdhwJqSP0+/E8R31El92EO1+selLy6hD3ro\nNX3iehtcQVKdQ/5rflP6K7ZbDDj76lgRBbOY+UT1tft1nvdgKIoRPMqlBc2tMLNT\njzJrw/AW7C9pRUTvox2uFKw0Eo/0pnSR4qllBCGE67VpJLXeMQFjwOLcaKX57civ\nX1z7nGTg4K+Ye5BM33Pq0Df24M0qLeqD6vLhB0Ny2JFiivw4zWJu448RELb1Omai\naNipdHQDN8D345mjctUDcc/2T7q6bcu5ErrFT8GK/FPdwpgDIPN20gxEMR9vG83n\nAMkzSNrMefNlJoyTdgthokPb99LmN6Foybk6VNoKy4u/mID6uprWGMIl1/LX2wu1\nxRxRy1YznHnmtGqTYOikyAp0e+4tDfHMZ58yC9/XGztxJvj6vvwwf9n5ZO4MC4Kj\nXQVHErcrTa8cZWW87pLrNvILegPA6v778BV0GLV5PqnWhl9Y1sY=\n=SrzP\n-----END + PGP PUBLIC KEY BLOCK-----\n"}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '1815' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/content_credentials + response: + body: + string: ' {"name":"RPM-GPG-KEY-my-repo2","content_type":"gpg_key","content":"-----BEGIN + PGP PUBLIC KEY BLOCK-----\nmQINBGAX2bIBEADuTGNExTEST0hOcpJ13XS1BEwuhzo7r16QaI0hP1vRxZeLJgeC\nb2KWRvHHfepr2jdAoAeOVhERrMz5EpMcgPEs7NUE+vbYr+K9LFzw5gmUC00CCuQ+\nRCJRRXYNV8F41y4dTGOkE/ON52ljDvVyFb3DbUUYPH9ZfOE0Z6kMIcJo6eYsDAdK\nEjoQ1jQkVaRa8I4+YZ9XEFkPqVUkY1+tMfipqqQuNbvN2xgQSk8dc6uEouyC8FBA\nGPugplbCaEZNFWt48xQU9vP1JblQ6z9cynLKFxxWkgr9DKRRh1kw2pIQyGhl1RhI\nuvedY9OeJlqxuBsBvko7JULcX622HcHUkhzQD+ss0L9nE3lZuO5ywpZdTYln296E\n7awNEr0ER9Xqx9pMp5JeXNSHjlleFN01vLG5Xa7WNc32fvDtn2JhkzTU/dlIA2F+\nw5Tlg5ROY8olWc+jHKmvTQwxZ9s9XQuHmBpNbOijHg4Ekr0TGo6d3rjHZKiisZBG\nmAbHe1pWLOmeRpjqc6xmIpDMrsx75U0WgkwjBtbfxUcDYEzzJOcO87Q3s8kH+ie3\n5eSClT7coImWUmVKIoFSvxj8JgUT6P81v7CW4AlVDpRjBtYmc82NsGuSEgAykuQo\nVRguqU/w3QTU3rEcWfLVmyfyEKC4tBUCAhGShii/rLrtCspBT+uVpcDkQwARAQAB\ntD1Gb3JlbWFuIEF1dG9tYXRpYyBTaWduaW5nIEtleSAoMi40KSA8cGFja2FnZXNA\ndGhlZm9yZW1hbi5vcmc+iQJUBBMBCAA+FiEEZDJT9xuCsb6vLh1PpDm9Vawq2fEF\nAmAX2bICGy8FCQHhM4AFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQpDm9Vawq\n2fHMBQ//ffbTmU0Bl9Im8dDCzebhO6/D3iyshoceAfUjJrwvuhzSlil2cjWiLdmP\nCjBhUB8eDRhSQ+LlfJe9C0PKEyC72rzTsfUZj4NBKNQGT2P+peJ1l8PUAAlk7jZl\nQZcDER9Nju7/d+VTqF6PXkcbnIo1GVD/EX+R9mKphIbu9qaxBqGhCVay1D7jNxzH\nOBaMse5hf1hJ0WzcyK6pRLMU9JeuLEdhwJqSP0+/E8R31El92EO1+selLy6hD3ro\nNX3iehtcQVKdQ/5rflP6K7ZbDDj76lgRBbOY+UT1tft1nvdgKIoRPMqlBc2tMLNT\njzJrw/AW7C9pRUTvox2uFKw0Eo/0pnSR4qllBCGE67VpJLXeMQFjwOLcaKX57civ\nX1z7nGTg4K+Ye5BM33Pq0Df24M0qLeqD6vLhB0Ny2JFiivw4zWJu448RELb1Omai\naNipdHQDN8D345mjctUDcc/2T7q6bcu5ErrFT8GK/FPdwpgDIPN20gxEMR9vG83n\nAMkzSNrMefNlJoyTdgthokPb99LmN6Foybk6VNoKy4u/mID6uprWGMIl1/LX2wu1\nxRxRy1YznHnmtGqTYOikyAp0e+4tDfHMZ58yC9/XGztxJvj6vvwwf9n5ZO4MC4Kj\nXQVHErcrTa8cZWW87pLrNvILegPA6v778BV0GLV5PqnWhl9Y1sY=\n=SrzP\n-----END + PGP PUBLIC KEY BLOCK-----\n","id":9,"organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"created_at":"2021-04-08 + 18:48:47 UTC","updated_at":"2021-04-08 18:48:47 UTC","gpg_key_products":[],"gpg_key_repos":[],"ssl_ca_products":[],"ssl_ca_root_repos":[],"ssl_client_products":[],"ssl_client_root_repos":[],"ssl_key_products":[],"ssl_key_root_repos":[],"permissions":{"view_content_credenials":true,"edit_content_credenials":true,"destroy_content_credenials":true}} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 From fdfca45c939ab7e26da74fab66200bcd5daa5950 Mon Sep 17 00:00:00 2001 From: "Eric D. Helms" Date: Tue, 13 Apr 2021 14:39:07 -0400 Subject: [PATCH 27/56] Add a domain_info module --- changelogs/fragments/domain-info-module.yml | 2 + plugins/modules/domain_info.py | 81 ++++++++ tests/fixtures/apidoc/domain_info.json | 1 + tests/test_playbooks/domain_info.yml | 83 ++++++++ .../test_playbooks/fixtures/domain_info-0.yml | 177 ++++++++++++++++++ .../test_playbooks/fixtures/domain_info-1.yml | 117 ++++++++++++ 6 files changed, 461 insertions(+) create mode 100644 changelogs/fragments/domain-info-module.yml create mode 100644 plugins/modules/domain_info.py create mode 120000 tests/fixtures/apidoc/domain_info.json create mode 100644 tests/test_playbooks/domain_info.yml create mode 100644 tests/test_playbooks/fixtures/domain_info-0.yml create mode 100644 tests/test_playbooks/fixtures/domain_info-1.yml diff --git a/changelogs/fragments/domain-info-module.yml b/changelogs/fragments/domain-info-module.yml new file mode 100644 index 00000000..016ea4c1 --- /dev/null +++ b/changelogs/fragments/domain-info-module.yml @@ -0,0 +1,2 @@ +minor_changes: + - Add a domain_info module diff --git a/plugins/modules/domain_info.py b/plugins/modules/domain_info.py new file mode 100644 index 00000000..f5e5525f --- /dev/null +++ b/plugins/modules/domain_info.py @@ -0,0 +1,81 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# (c) 2021 Eric Helms +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +DOCUMENTATION = ''' +--- +module: domain_info +version_added: 2.1.0 +short_description: Fetch information about Domains +description: + - Fetch information about Domains +author: + - "Eric Helms (@ehelms)" +extends_documentation_fragment: + - theforeman.foreman.foreman + - theforeman.foreman.foreman.infomodule +''' + +EXAMPLES = ''' +- name: "Show a domain" + theforeman.foreman.domain_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + name: "example.com" + +- name: "Show all domains with domain example.com" + theforeman.foreman.domain_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + search: "name = example.com" +''' + +RETURN = ''' +domain: + description: Details about the found domain + returned: success and I(name) was passed + type: dict +domains: + description: List of all found domains and their details + returned: success and I(search) was passed + type: list + elements: dict +''' + +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( + ForemanInfoAnsibleModule, +) + + +class ForemanDomainInfo(ForemanInfoAnsibleModule): + pass + + +def main(): + module = ForemanDomainInfo() + + with module.api_connection(): + module.run() + + +if __name__ == '__main__': + main() diff --git a/tests/fixtures/apidoc/domain_info.json b/tests/fixtures/apidoc/domain_info.json new file mode 120000 index 00000000..f9e40151 --- /dev/null +++ b/tests/fixtures/apidoc/domain_info.json @@ -0,0 +1 @@ +foreman.json \ No newline at end of file diff --git a/tests/test_playbooks/domain_info.yml b/tests/test_playbooks/domain_info.yml new file mode 100644 index 00000000..fc34d17f --- /dev/null +++ b/tests/test_playbooks/domain_info.yml @@ -0,0 +1,83 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + - vars/domain.yml + tasks: + - include_tasks: tasks/location.yml + vars: + location_name: "{{ item }}" + location_state: "present" + with_items: "{{ domain_locations }}" + - include_tasks: tasks/organization.yml + vars: + organization_name: "{{ item }}" + organization_state: "present" + with_items: "{{ domain_organizations }}" + - include_tasks: tasks/domain.yml + vars: + domain_state: "absent" + - name: create domain + include_tasks: tasks/domain.yml + vars: + domain_state: "present" + expected_change: true + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: fetch domain info + domain_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + name: "example.com" + register: domain_info + - name: check domain details + assert: + that: + - domain_info['domain']['name'] == "example.com" + + - name: search domain info + domain_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + search: "name = example.com" + register: domain_info + - name: check domain details + assert: + that: + - domain_info['domains'][0]['name'] == "example.com" + +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + - vars/domain.yml + tasks: + - include_tasks: tasks/domain.yml + vars: + domain_state: "absent" + - include_tasks: tasks/location.yml + vars: + location_name: "{{ item }}" + location_state: "absent" + with_items: "{{ domain_locations }}" + - include_tasks: tasks/organization.yml + vars: + organization_name: "{{ item }}" + organization_state: "absent" + with_items: "{{ domain_organizations }}" +... diff --git a/tests/test_playbooks/fixtures/domain_info-0.yml b/tests/test_playbooks/fixtures/domain_info-0.yml new file mode 100644 index 00000000..9bce1ff0 --- /dev/null +++ b/tests/test_playbooks/fixtures/domain_info-0.yml @@ -0,0 +1,177 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/domains?search=name%3D%22example.com%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"example.com\\\"\",\n \"sort\": {\n + \ \"by\": null,\n \"order\": null\n },\n \"results\": [{\"fullname\":null,\"created_at\":\"2021-04-13 + 18:34:44 UTC\",\"updated_at\":\"2021-04-13 18:34:44 UTC\",\"id\":2,\"name\":\"example.com\",\"dns_id\":null,\"dns\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '325' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/domains/2 + response: + body: + string: '{"fullname":null,"created_at":"2021-04-13 18:34:44 UTC","updated_at":"2021-04-13 + 18:34:44 UTC","id":2,"name":"example.com","dns_id":null,"dns":null,"subnets":[],"interfaces":[],"parameters":[],"locations":[{"id":8,"name":"Test + Location","title":"Test Location","description":null},{"id":9,"name":"Sublocation","title":"Test + Location/Sublocation","description":null}],"organizations":[{"id":7,"name":"Test + Organization","title":"Test Organization","description":"A test organization"}]}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '485' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/domain_info-1.yml b/tests/test_playbooks/fixtures/domain_info-1.yml new file mode 100644 index 00000000..e8c2223f --- /dev/null +++ b/tests/test_playbooks/fixtures/domain_info-1.yml @@ -0,0 +1,117 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/domains?search=name+%3D+example.com&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name = example.com\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"fullname\":null,\"created_at\":\"2021-04-13 + 18:34:44 UTC\",\"updated_at\":\"2021-04-13 18:34:44 UTC\",\"id\":2,\"name\":\"example.com\",\"dns_id\":null,\"dns\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '323' + status: + code: 200 + message: OK +version: 1 From 1bd19e528d547e861ac4cf12d9e7e43653d72469 Mon Sep 17 00:00:00 2001 From: "Eric D. Helms" Date: Tue, 13 Apr 2021 14:27:08 -0400 Subject: [PATCH 28/56] Add a setting_info module --- plugins/modules/setting_info.py | 81 ++++++++ tests/fixtures/apidoc/setting_info.json | 1 + .../fixtures/setting_info-0.yml | 177 ++++++++++++++++++ .../fixtures/setting_info-1.yml | 119 ++++++++++++ tests/test_playbooks/setting_info.yml | 44 +++++ 5 files changed, 422 insertions(+) create mode 100644 plugins/modules/setting_info.py create mode 120000 tests/fixtures/apidoc/setting_info.json create mode 100644 tests/test_playbooks/fixtures/setting_info-0.yml create mode 100644 tests/test_playbooks/fixtures/setting_info-1.yml create mode 100644 tests/test_playbooks/setting_info.yml diff --git a/plugins/modules/setting_info.py b/plugins/modules/setting_info.py new file mode 100644 index 00000000..9b506c2c --- /dev/null +++ b/plugins/modules/setting_info.py @@ -0,0 +1,81 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# (c) 2021 Eric D Helms +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +DOCUMENTATION = ''' +--- +module: setting_info +version_added: 2.1.0 +short_description: Fetch information about Settings +description: + - Fetch information about Settings +author: + - "Eric Helms (@ehelms)" +extends_documentation_fragment: + - theforeman.foreman.foreman + - theforeman.foreman.foreman.infomodule +''' + +EXAMPLES = ''' +- name: "Show a setting" + theforeman.foreman.setting_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + name: "http_proxy" + +- name: "Show all settings with proxy" + theforeman.foreman.setting_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + search: "name = proxy" +''' + +RETURN = ''' +setting: + description: Details about the found setting + returned: success and I(name) was passed + type: dict +settings: + description: List of all found settings and their details + returned: success and I(search) was passed + type: list + elements: dict +''' + +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( + ForemanInfoAnsibleModule, +) + + +class ForemanSettingInfo(ForemanInfoAnsibleModule): + pass + + +def main(): + module = ForemanSettingInfo() + + with module.api_connection(): + module.run() + + +if __name__ == '__main__': + main() diff --git a/tests/fixtures/apidoc/setting_info.json b/tests/fixtures/apidoc/setting_info.json new file mode 120000 index 00000000..f9e40151 --- /dev/null +++ b/tests/fixtures/apidoc/setting_info.json @@ -0,0 +1 @@ +foreman.json \ No newline at end of file diff --git a/tests/test_playbooks/fixtures/setting_info-0.yml b/tests/test_playbooks/fixtures/setting_info-0.yml new file mode 100644 index 00000000..19e8a439 --- /dev/null +++ b/tests/test_playbooks/fixtures/setting_info-0.yml @@ -0,0 +1,177 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/settings?search=name%3D%22login_text%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 181,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name=\\\"login_text\\\"\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"description\":\"Text + to be shown in the login-page footer\",\"category\":\"Setting::General\",\"settings_type\":null,\"default\":null,\"created_at\":\"2021-04-08 + 18:01:52 UTC\",\"updated_at\":\"2021-04-13 18:24:31 UTC\",\"id\":\"login_text\",\"name\":\"login_text\",\"full_name\":\"Login + page footer text\",\"value\":\"\",\"category_name\":\"General\",\"readonly\":false,\"config_file\":\"settings.yaml\",\"encrypted\":false,\"select_values\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '579' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/settings/login_text + response: + body: + string: '{"description":"Text to be shown in the login-page footer","category":"Setting::General","settings_type":null,"default":null,"created_at":"2021-04-08 + 18:01:52 UTC","updated_at":"2021-04-13 18:24:31 UTC","id":"login_text","name":"login_text","full_name":"Login + page footer text","value":"","category_name":"General","readonly":false,"config_file":"settings.yaml","encrypted":false,"select_values":null}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '401' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/setting_info-1.yml b/tests/test_playbooks/fixtures/setting_info-1.yml new file mode 100644 index 00000000..991eeab7 --- /dev/null +++ b/tests/test_playbooks/fixtures/setting_info-1.yml @@ -0,0 +1,119 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.5.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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '70' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/settings?search=name+%3D+token_duration&per_page=4294967296 + response: + body: + string: "{\n \"total\": 181,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\": + 4294967296,\n \"search\": \"name = token_duration\",\n \"sort\": {\n \"by\": + null,\n \"order\": null\n },\n \"results\": [{\"description\":\"Time + in minutes installation tokens should be valid for, 0 to disable token generation\",\"category\":\"Setting::Provisioning\",\"settings_type\":\"integer\",\"default\":360,\"created_at\":\"2021-04-08 + 18:01:53 UTC\",\"updated_at\":\"2021-04-08 18:01:53 UTC\",\"id\":\"token_duration\",\"name\":\"token_duration\",\"full_name\":\"Token + duration\",\"value\":360,\"category_name\":\"Provisioning\",\"readonly\":false,\"config_file\":\"settings.yaml\",\"encrypted\":false,\"select_values\":null}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.5.0-develop + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '641' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/setting_info.yml b/tests/test_playbooks/setting_info.yml new file mode 100644 index 00000000..48084944 --- /dev/null +++ b/tests/test_playbooks/setting_info.yml @@ -0,0 +1,44 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include: tasks/setting.yml + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: fetch setting info + setting_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + name: "login_text" + register: setting_info + - name: check setting details + assert: + that: + - setting_info['setting']['name'] == "login_text" + - setting_info['setting']['value'] == '' + + - name: search setting info + setting_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + search: "name = token_duration" + register: setting_info + - name: check setting details + assert: + that: + - setting_info['settings'][0]['name'] == "token_duration" +... From ab4faa1cdc2f56cf5eca6b27388018563b848156 Mon Sep 17 00:00:00 2001 From: Hideki Saito Date: Wed, 24 Mar 2021 15:15:36 +0900 Subject: [PATCH 29/56] Set validate_certs to API call to avoid effects from environment vars * Addresses an issue where "requests" uses REQUESTS_CA_BUNDLE or CURL_CA_BUNDLE values for API call even if validate_certs set False Signed-off-by: Hideki Saito --- plugins/inventory/foreman.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/plugins/inventory/foreman.py b/plugins/inventory/foreman.py index 88c8a438..b7782ebc 100644 --- a/plugins/inventory/foreman.py +++ b/plugins/inventory/foreman.py @@ -237,7 +237,11 @@ def _get_json(self, url, ignore_errors=None, params=None): params['page'] = 1 params['per_page'] = self.get_option('batch_size') while True: - ret = s.get(url, params=params) + # workaround to address the follwing issues where 'verify' is overridden in Requests: + # - https://github.com/psf/requests/issues/3829 + # - https://github.com/psf/requests/issues/5209 + ret = s.get(url, params=params, verify=self.get_option('validate_certs')) + if ignore_errors and ret.status_code in ignore_errors: break ret.raise_for_status() From f66651fa7c71de80c2c7d05dc721832f59de3aee Mon Sep 17 00:00:00 2001 From: Chris Hindman Date: Fri, 18 Dec 2020 10:20:45 -0500 Subject: [PATCH 30/56] create organizations role Fixes #1109 --- roles/organizations/README.md | 67 +++++++++++++++++++++++++++ roles/organizations/defaults/main.yml | 3 ++ roles/organizations/tasks/main.yml | 16 +++++++ 3 files changed, 86 insertions(+) create mode 100644 roles/organizations/README.md create mode 100644 roles/organizations/defaults/main.yml create mode 100644 roles/organizations/tasks/main.yml diff --git a/roles/organizations/README.md b/roles/organizations/README.md new file mode 100644 index 00000000..0b94a85f --- /dev/null +++ b/roles/organizations/README.md @@ -0,0 +1,67 @@ +# theforeman.foreman.organizations + +## Description +An Ansible Role to create Organizations in Foreman. + +## Variables +|Variable Name|Default Value|Required|Description|Example| +|:---:|:---:|:---:|:---:|:---:| +|`foreman_server_url`|" "|no|URL of the Foreman server.| +|`foreman_username`|" "|no|Username accessing the Foreman Server.| +|`foreman_password`|" "|no|Password of user accessing the Foreman Server. This should be stored at vars/foreman-secrets.yml or elsewhere.| +|`foreman_validate_certs`|"True"|no|Whether or not to verify the TLS certificates of the Foreman server.| +|`foreman_organizations`|[ ]|no|Manage the Foreman Organization.| + +### Secure Logging Variables +The following Variables compliment each other. +If both variables are not set, secure logging defaults to false. +The role defaults to False as normally the add organization task does not include sensitive information. +foreman_configuration_organizations_secure_logging defaults to the value of foreman_configuration_secure_logging if it is not explicitly called. This allows for secure logging to be toggled for the entire suite of configuration roles with a single variable, or for the user to selectively use it. + +|Variable Name|Default Value|Required|Description| +|:---:|:---:|:---:|:---:| +|`foreman_configuration_organizations_secure_logging`|`False`|no|Whether or not to include the sensitive Organization role tasks in the log. Set this value to `True` if you will be providing your sensitive values from elsewhere.| +|`forman_configuration_secure_logging`|`False`|no|This variable enables secure logging as well, but is shared across multiple roles, see above.| + +## Organization Data Structure +This role accepts two data models. A simple straightforward easy to maintain model, and another based on the tower api. The 2nd one is more complicated and includes more detail, and is compatiable with tower import/export. + +### Variables +|Variable Name|Default Value|Required|Description| +|:---:|:---:|:---:|:---:| +|`name`|" "|yes|Name of Organization.| +|`description`|" "|no|Description of Named Organization.| +|`label`|" "|no|Label of the Organization.| +|`state`|`present`|no|Desired State of the Entity.| + +## Playbook Examples +### Standard Role Usage +```yaml +--- +- name: add organizations to foreman + hosts: localhost + connection: local + gather_facts: false + vars_files: + - ../tests/vars/foreman_secrets.yml + tasks: + - name: add organizations + include_role: + name: ../.. + vars: + foreman_server_url: url + foreman_username: user + foreman_password: pass + foreman_validate_certs: no + foreman_organizations: + - name: raleigh + label: rdu + state: present + - name: default + label: boring + state: absent + - name: lanai + description: pacific datacenter +``` +## Author +[Chris Hindman](https://github.com/hindman-redhat) \ No newline at end of file diff --git a/roles/organizations/defaults/main.yml b/roles/organizations/defaults/main.yml new file mode 100644 index 00000000..05a708a2 --- /dev/null +++ b/roles/organizations/defaults/main.yml @@ -0,0 +1,3 @@ +--- +foreman_organizations: [] +foreman_configuration_organizations_secure_logging: "{{foreman_configuration_secure_logging | default(false) }}" \ No newline at end of file diff --git a/roles/organizations/tasks/main.yml b/roles/organizations/tasks/main.yml new file mode 100644 index 00000000..64891228 --- /dev/null +++ b/roles/organizations/tasks/main.yml @@ -0,0 +1,16 @@ +--- +- name: Add organizations + theforeman.foreman.organization: + name: "{{ foreman_organizations_item.name }}" + description: "{{ foreman_organizations_item.description | default(omit) }}" + label: "{{ foreman_organizations_item.label | default(omit) }}" + server_url: "{{ foreman_server_url | default(omit) }}" + username: "{{ foreman_username | default(omit) }}" + password: "{{ foreman_password | default(omit) }}" + validate_certs: "{{ foreman_validate_certs | default(omit) }}" + parameters: "{{ foreman_organizations_item.parameters | default(omit) }}" + state: "{{ foreman_organizations_item.state | default(omit) }}" + loop: "{{ foreman_organizations }}" + loop_control: + loop_var: foreman_organizations_item + no_log: "{{ foreman_configuration_organizations_secure_logging }}" \ No newline at end of file From b255415f29c4ebbf0657ef16e84e7c9bcf9bf2f7 Mon Sep 17 00:00:00 2001 From: willtome Date: Mon, 18 Jan 2021 13:53:07 -0500 Subject: [PATCH 31/56] update README to current standards --- roles/organizations/README.md | 49 ++++++++++++------------------ roles/organizations/tasks/main.yml | 2 +- 2 files changed, 21 insertions(+), 30 deletions(-) diff --git a/roles/organizations/README.md b/roles/organizations/README.md index 0b94a85f..d39b8d78 100644 --- a/roles/organizations/README.md +++ b/roles/organizations/README.md @@ -3,56 +3,47 @@ ## Description An Ansible Role to create Organizations in Foreman. -## Variables -|Variable Name|Default Value|Required|Description|Example| -|:---:|:---:|:---:|:---:|:---:| -|`foreman_server_url`|" "|no|URL of the Foreman server.| -|`foreman_username`|" "|no|Username accessing the Foreman Server.| -|`foreman_password`|" "|no|Password of user accessing the Foreman Server. This should be stored at vars/foreman-secrets.yml or elsewhere.| -|`foreman_validate_certs`|"True"|no|Whether or not to verify the TLS certificates of the Foreman server.| -|`foreman_organizations`|[ ]|no|Manage the Foreman Organization.| +Role Variables +-------------- + +This role supports the [Common Role Variables](https://github.com/theforeman/foreman-ansible-modules/blob/develop/README.md#common-role-variables). + +- `foreman_organizations`: list of organizations to manage. See Variables table below for data structure definition. Default is `[]`. + +### Organization Data Structure +|Variable Name|Default Value|Required|Description| +|:---:|:---:|:---:|:---:| +|`name`|" "|yes|Name of Organization.| +|`description`|" "|no|Description of Named Organization.| +|`label`|" "|no|Label of the Organization.| +|`state`|`present`|no|Desired State of the Entity.| ### Secure Logging Variables The following Variables compliment each other. If both variables are not set, secure logging defaults to false. The role defaults to False as normally the add organization task does not include sensitive information. -foreman_configuration_organizations_secure_logging defaults to the value of foreman_configuration_secure_logging if it is not explicitly called. This allows for secure logging to be toggled for the entire suite of configuration roles with a single variable, or for the user to selectively use it. +`foreman_configuration_organizations_secure_logging` defaults to the value of `foreman_configuration_secure_logging` if it is not explicitly called. This allows for secure logging to be toggled for the entire suite of configuration roles with a single variable, or for the user to selectively use it. |Variable Name|Default Value|Required|Description| |:---:|:---:|:---:|:---:| |`foreman_configuration_organizations_secure_logging`|`False`|no|Whether or not to include the sensitive Organization role tasks in the log. Set this value to `True` if you will be providing your sensitive values from elsewhere.| |`forman_configuration_secure_logging`|`False`|no|This variable enables secure logging as well, but is shared across multiple roles, see above.| -## Organization Data Structure -This role accepts two data models. A simple straightforward easy to maintain model, and another based on the tower api. The 2nd one is more complicated and includes more detail, and is compatiable with tower import/export. - -### Variables -|Variable Name|Default Value|Required|Description| -|:---:|:---:|:---:|:---:| -|`name`|" "|yes|Name of Organization.| -|`description`|" "|no|Description of Named Organization.| -|`label`|" "|no|Label of the Organization.| -|`state`|`present`|no|Desired State of the Entity.| - ## Playbook Examples ### Standard Role Usage ```yaml --- - name: add organizations to foreman hosts: localhost - connection: local gather_facts: false - vars_files: - - ../tests/vars/foreman_secrets.yml tasks: - name: add organizations include_role: - name: ../.. + name: theforeman.foreman.organizations vars: - foreman_server_url: url - foreman_username: user - foreman_password: pass - foreman_validate_certs: no + foreman_server_url: https://foreman.example.com + foreman_username: admin + foreman_password: changeme foreman_organizations: - name: raleigh label: rdu @@ -64,4 +55,4 @@ This role accepts two data models. A simple straightforward easy to maintain mod description: pacific datacenter ``` ## Author -[Chris Hindman](https://github.com/hindman-redhat) \ No newline at end of file +[Chris Hindman](https://github.com/hindman-redhat) diff --git a/roles/organizations/tasks/main.yml b/roles/organizations/tasks/main.yml index 64891228..2382cc26 100644 --- a/roles/organizations/tasks/main.yml +++ b/roles/organizations/tasks/main.yml @@ -13,4 +13,4 @@ loop: "{{ foreman_organizations }}" loop_control: loop_var: foreman_organizations_item - no_log: "{{ foreman_configuration_organizations_secure_logging }}" \ No newline at end of file + no_log: "{{ foreman_configuration_organizations_secure_logging }}" From 4624636374fb5d0d9f36ca76656eed14ef38cce2 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Tue, 20 Apr 2021 12:36:53 +0200 Subject: [PATCH 32/56] no secure logging --- roles/organizations/README.md | 11 ----------- roles/organizations/defaults/main.yml | 1 - roles/organizations/tasks/main.yml | 1 - 3 files changed, 13 deletions(-) diff --git a/roles/organizations/README.md b/roles/organizations/README.md index d39b8d78..99ee25c7 100644 --- a/roles/organizations/README.md +++ b/roles/organizations/README.md @@ -18,17 +18,6 @@ This role supports the [Common Role Variables](https://github.com/theforeman/for |`label`|" "|no|Label of the Organization.| |`state`|`present`|no|Desired State of the Entity.| -### Secure Logging Variables -The following Variables compliment each other. -If both variables are not set, secure logging defaults to false. -The role defaults to False as normally the add organization task does not include sensitive information. -`foreman_configuration_organizations_secure_logging` defaults to the value of `foreman_configuration_secure_logging` if it is not explicitly called. This allows for secure logging to be toggled for the entire suite of configuration roles with a single variable, or for the user to selectively use it. - -|Variable Name|Default Value|Required|Description| -|:---:|:---:|:---:|:---:| -|`foreman_configuration_organizations_secure_logging`|`False`|no|Whether or not to include the sensitive Organization role tasks in the log. Set this value to `True` if you will be providing your sensitive values from elsewhere.| -|`forman_configuration_secure_logging`|`False`|no|This variable enables secure logging as well, but is shared across multiple roles, see above.| - ## Playbook Examples ### Standard Role Usage ```yaml diff --git a/roles/organizations/defaults/main.yml b/roles/organizations/defaults/main.yml index 05a708a2..3d13d0a8 100644 --- a/roles/organizations/defaults/main.yml +++ b/roles/organizations/defaults/main.yml @@ -1,3 +1,2 @@ --- foreman_organizations: [] -foreman_configuration_organizations_secure_logging: "{{foreman_configuration_secure_logging | default(false) }}" \ No newline at end of file diff --git a/roles/organizations/tasks/main.yml b/roles/organizations/tasks/main.yml index 2382cc26..138f42d9 100644 --- a/roles/organizations/tasks/main.yml +++ b/roles/organizations/tasks/main.yml @@ -13,4 +13,3 @@ loop: "{{ foreman_organizations }}" loop_control: loop_var: foreman_organizations_item - no_log: "{{ foreman_configuration_organizations_secure_logging }}" From 2215a81a0d428538905f3960016d4433eaa74795 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Tue, 20 Apr 2021 12:43:18 +0200 Subject: [PATCH 33/56] cleanup --- roles/organizations/README.md | 59 +++++++++++++-------------- roles/organizations/defaults/main.yml | 2 - roles/organizations/tasks/main.yml | 19 ++++----- 3 files changed, 37 insertions(+), 43 deletions(-) delete mode 100644 roles/organizations/defaults/main.yml diff --git a/roles/organizations/README.md b/roles/organizations/README.md index 99ee25c7..e5d87ebf 100644 --- a/roles/organizations/README.md +++ b/roles/organizations/README.md @@ -1,47 +1,44 @@ -# theforeman.foreman.organizations +theforeman.foreman.organizations +================================ -## Description -An Ansible Role to create Organizations in Foreman. +This role creates and manages organizations. Role Variables -------------- This role supports the [Common Role Variables](https://github.com/theforeman/foreman-ansible-modules/blob/develop/README.md#common-role-variables). -- `foreman_organizations`: list of organizations to manage. See Variables table below for data structure definition. Default is `[]`. +The main data structure for this role is the list of `foreman_organizations`. Each `organization` requires the following fields: -### Organization Data Structure -|Variable Name|Default Value|Required|Description| -|:---:|:---:|:---:|:---:| -|`name`|" "|yes|Name of Organization.| -|`description`|" "|no|Description of Named Organization.| -|`label`|" "|no|Label of the Organization.| -|`state`|`present`|no|Desired State of the Entity.| +- `name`: The name of the organization. + +The following fields are optional in the sense that the server will use default values when they are omitted: + +- `label`: The label of the organization. +- `description`: The description of the organization. +- `state`: The state of the organization. Can be `present` or `absent`. + +Example Playbooks +----------------- -## Playbook Examples -### Standard Role Usage ```yaml --- - name: add organizations to foreman hosts: localhost gather_facts: false - tasks: - - name: add organizations - include_role: - name: theforeman.foreman.organizations + roles: + - role: theforeman.foreman.organizations vars: - foreman_server_url: https://foreman.example.com - foreman_username: admin - foreman_password: changeme - foreman_organizations: - - name: raleigh - label: rdu - state: present - - name: default - label: boring - state: absent - - name: lanai - description: pacific datacenter + foreman_server_url: https://foreman.example.com + foreman_username: admin + foreman_password: changeme + foreman_organizations: + - name: raleigh + label: rdu + state: present + - name: default + label: boring + state: absent + - name: lanai + description: pacific datacenter ``` -## Author -[Chris Hindman](https://github.com/hindman-redhat) diff --git a/roles/organizations/defaults/main.yml b/roles/organizations/defaults/main.yml deleted file mode 100644 index 3d13d0a8..00000000 --- a/roles/organizations/defaults/main.yml +++ /dev/null @@ -1,2 +0,0 @@ ---- -foreman_organizations: [] diff --git a/roles/organizations/tasks/main.yml b/roles/organizations/tasks/main.yml index 138f42d9..c130b0d3 100644 --- a/roles/organizations/tasks/main.yml +++ b/roles/organizations/tasks/main.yml @@ -1,15 +1,14 @@ --- - name: Add organizations theforeman.foreman.organization: - name: "{{ foreman_organizations_item.name }}" - description: "{{ foreman_organizations_item.description | default(omit) }}" - label: "{{ foreman_organizations_item.label | default(omit) }}" - server_url: "{{ foreman_server_url | default(omit) }}" - username: "{{ foreman_username | default(omit) }}" - password: "{{ foreman_password | default(omit) }}" - validate_certs: "{{ foreman_validate_certs | default(omit) }}" - parameters: "{{ foreman_organizations_item.parameters | default(omit) }}" - state: "{{ foreman_organizations_item.state | default(omit) }}" - loop: "{{ foreman_organizations }}" + name: "{{ foreman_organizations_item.name }}" + description: "{{ foreman_organizations_item.description | default(omit) }}" + label: "{{ foreman_organizations_item.label | default(omit) }}" + server_url: "{{ foreman_server_url | default(omit) }}" + username: "{{ foreman_username | default(omit) }}" + password: "{{ foreman_password | default(omit) }}" + validate_certs: "{{ foreman_validate_certs | default(omit) }}" + state: "{{ foreman_organizations_item.state | default(omit) }}" + loop: "{{ foreman_organizations | default([]) }}" loop_control: loop_var: foreman_organizations_item From caa1070ae100452ff532362cbc8e42958fa69b9b Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Tue, 20 Apr 2021 13:27:07 +0200 Subject: [PATCH 34/56] add test --- tests/fixtures/apidoc/organizations_role.json | 1 + .../fixtures/organizations_role-0.yml | 273 +++++++++++++++++ .../fixtures/organizations_role-1.yml | 274 ++++++++++++++++++ tests/test_playbooks/organizations_role.yml | 46 +++ 4 files changed, 594 insertions(+) create mode 100644 tests/fixtures/apidoc/organizations_role.json create mode 100644 tests/test_playbooks/fixtures/organizations_role-0.yml create mode 100644 tests/test_playbooks/fixtures/organizations_role-1.yml create mode 100644 tests/test_playbooks/organizations_role.yml diff --git a/tests/fixtures/apidoc/organizations_role.json b/tests/fixtures/apidoc/organizations_role.json new file mode 100644 index 00000000..d35ba7b2 --- /dev/null +++ b/tests/fixtures/apidoc/organizations_role.json @@ -0,0 +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":{"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","id":"template_combinations","api_url":"/api","name":"Template combinations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"architectures":{"doc_url":"../apidoc/v2/architectures","id":"architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"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 String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"../apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template inputs","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"../apidoc/v2/audits","id":"audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"action","type":"string"},{"name":"auditable_id","type":"integer"},{"name":"changes","type":"text"},{"name":"comment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"interface_fqdn","type":"string"},{"name":"interface_ip","type":"string"},{"name":"interface_mac","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_title","type":"string"},{"name":"parameter","type":"string"},{"name":"partition_table","type":"string"},{"name":"provisioning_template","type":"string"},{"name":"puppetclass","type":"string"},{"name":"remote_address","type":"string"},{"name":"request_uuid","type":"string"},{"name":"setting","type":"string"},{"name":"time","type":"datetime"},{"name":"type","values":["operatingsystem","role","ptable","provisioning_template","user","auth_source","compute_resource","host","interface","location","organization","os","override_value","parameter","partition_table","setting","smart_class_parameter","subnet"]},{"name":"user","type":"string"},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"../apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal access tokens","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"../apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth source externals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ping":{"doc_url":"../apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"auth_source_internals":{"doc_url":"../apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth source internals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"plugins":{"doc_url":"../apidoc/v2/plugins","id":"plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","id":"auth_source_ldaps","api_url":"/api","name":"Auth source ldaps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","id":"template_kinds","api_url":"/api","name":"Template kinds","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_sources":{"doc_url":"../apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth sources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"trends":{"doc_url":"../apidoc/v2/trends","id":"trends","api_url":"/api","name":"Trends","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API enpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/trends/index","name":"index","apis":[{"api_url":"/api/trends","http_method":"GET","short_description":"List of trends counters","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/show","name":"show","apis":[{"api_url":"/api/trends/:id","http_method":"GET","short_description":"Show a trend","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/create","name":"create","apis":[{"api_url":"/api/trends","http_method":"POST","short_description":"Create a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/destroy","name":"destroy","apis":[{"api_url":"/api/trends/:id","http_method":"DELETE","short_description":"Delete a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"autosign":{"doc_url":"../apidoc/v2/autosign","id":"autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","id":"usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the Foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","id":"bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"environment","type":"string"},{"name":"hostgroup","type":"string"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","id":"common_parameters","api_url":"/api","name":"Common parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"../apidoc/v2/ptables","id":"ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","id":"compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","id":"puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"key","type":"string"},{"name":"location","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","id":"compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_hosts":{"doc_url":"../apidoc/v2/puppet_hosts","id":"puppet_hosts","api_url":"/api","name":"Puppet hosts","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Remote Execution Plugin.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nRemote Execution Plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","id":"compute_resources","api_url":"/api","name":"Compute resources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"../apidoc/v2/users","id":"users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user if it is not already present.\nOnly another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_groups":{"doc_url":"../apidoc/v2/config_groups","id":"config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"class","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"../apidoc/v2/realms","id":"realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"environment","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","id":"dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"../apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are of the form\n\u003cem\u003ehostname\u003c/em\u003e.\u003cstrong\u003esomewhere.com\u003c/strong\u003e then the domain is\n\u003cstrong\u003esomewhere.com\u003c/strong\u003e. This allows Foreman to associate a puppet\nvariable with a domain/site and automatically append this variable to all\nexternal node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003efullname\u003c/strong\u003e field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"environments":{"doc_url":"../apidoc/v2/environments","id":"environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/environments","http_method":"GET","short_description":"List environments of Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/environments","http_method":"GET","short_description":"List environments per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"registration":{"doc_url":"../apidoc/v2/registration","id":"registration","api_url":"/api","name":"Registration","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/registration/global","name":"global","apis":[{"api_url":"/api/register","http_method":"GET","short_description":"Render Global registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the Organization to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of the Location to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of the Host group to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of the Operating System to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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\nset to true, insights client will be installed and registered on Red Hat\nfamily 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":[]},{"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\nit 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":[]}],"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 registration 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}]},{"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\nset to true, insights client will be installed and registered on Red Hat\nfamily 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":[]},{"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\nit 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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"interfaces":{"doc_url":"../apidoc/v2/interfaces","id":"interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","id":"external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","id":"fact_values","api_url":"/api","name":"Fact values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"../apidoc/v2/home","id":"home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_classes":{"doc_url":"../apidoc/v2/host_classes","id":"host_classes","api_url":"/api","name":"Host classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_classes/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"../apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action\nreturns an url to get resulting report from (see\n\u003cstrong\u003ereport_data\u003c/strong\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use \u0026#39;,\u0026#39; to\nseparate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API\nendpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is\ndelivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn\u0026#39;t\nbeen generated yet, it will return an empty response with http status 204 -\nNoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroup_classes":{"doc_url":"../apidoc/v2/hostgroup_classes","id":"hostgroup_classes","api_url":"/api","name":"Hostgroup classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroup_classes/index","name":"index","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/create","name":"create","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","id":"hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/hostgroups","http_method":"GET","short_description":"List all host groups for a Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"class","type":"string"},{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hosts":{"doc_url":"../apidoc/v2/hosts","id":"hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null},{"api_url":"/api/environments/:environment_id/hosts","http_method":"GET","short_description":"List hosts per environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"boot_time","type":"datetime"},{"name":"build","values":["true","false"]},{"name":"class","type":"string"},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"config_group","type":"string"},{"name":"created_at","type":"datetime"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"environment","type":"string"},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","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":"image","type":"string"},{"name":"installed_at","type":"datetime"},{"name":"ip","type":"string"},{"name":"last_report","type":"datetime"},{"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":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"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":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eglobal\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003econfiguration\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ebuild\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host\u0026#39;s compute attributes that can be used to create a clone\nof this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot),\n(cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE,\nprovision, finish, script, user_data, ZTP, POAP, cloud-init, registration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"../apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"../apidoc/v2/images","id":"images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"../apidoc/v2/locations","id":"locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"../apidoc/v2/roles","id":"roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"../apidoc/v2/media","id":"media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"../apidoc/v2/models","id":"models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"../apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","id":"operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"../apidoc/v2/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"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":"/api/organizations/:id","http_method":"GET","short_description":"Show 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/api/organizations","http_method":"POST","short_description":"Create 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"organization[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"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":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/api/organizations/:id","http_method":"PUT","short_description":"Update 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"organization[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"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":[]},{"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":[]}]},{"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, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"../apidoc/v2/settings","id":"settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","id":"os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"override_values":{"doc_url":"../apidoc/v2/override_values","id":"override_values","api_url":"/api","name":"Override values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/override_values/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"../apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cstrong\u003enested parameters for a host,\ndomain, subnet, host group, operating system\u003c/strong\u003e. If you are looking\nfor \u0026lt;a href=“common_parameters.html”\u0026gt;global parameters\u0026lt;/a\u0026gt;, go\nto \u0026lt;a href=“common_parameters.html”\u0026gt;this link\u0026lt;/a\u0026gt;.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"../apidoc/v2/permissions","id":"permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_class_parameters":{"doc_url":"../apidoc/v2/smart_class_parameters","id":"smart_class_parameters","api_url":"/api","name":"Smart class parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_class_parameters/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters","http_method":"GET","short_description":"List all smart class parameters","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment/Puppet class combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"avoid_duplicates","values":["true","false"]},{"name":"environment","type":"string"},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"},{"name":"puppetclass","type":"string"},{"name":"puppetclass_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"GET","short_description":"Show a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"PUT","short_description":"Update a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"\n\u003cp\u003eWhether the smart class parameter value is managed by Foreman\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003cp\u003eDescription of smart class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"\n\u003cp\u003eValue to use when there is no match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"smart_class_parameter[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"smart_class_parameter[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output. Puppet will\nuse the value defined in the Puppet manifest for this parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"smart_class_parameter[path]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"smart_class_parameter[required]","description":"\n\u003cp\u003eIf true, will raise an error if there is no default value and no matcher\nprovide a value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"smart_class_parameter[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"smart_class_parameter[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"smart_class_parameter[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","id":"smart_proxies","api_url":"/api","name":"Smart proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"../apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"statistics":{"doc_url":"../apidoc/v2/statistics","id":"statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API endpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install the\nForeman Statistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"subnets":{"doc_url":"../apidoc/v2/subnets","id":"subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}},"link_extension":".html"}} \ No newline at end of file diff --git a/tests/test_playbooks/fixtures/organizations_role-0.yml b/tests/test_playbooks/fixtures/organizations_role-0.yml new file mode 100644 index 00000000..40db4a92 --- /dev/null +++ b/tests/test_playbooks/fixtures/organizations_role-0.yml @@ -0,0 +1,273 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.0","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/organizations?search=name%3D%22Test+Organization+One%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization One\\\"\",\n \"\ + sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": []\n\ + }\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '187' + status: + code: 200 + message: OK +- request: + body: '{"organization": {"name": "Test Organization One"}}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '51' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/api/organizations + response: + body: + string: '{"select_all_types":[],"description":null,"created_at":"2021-04-20 + 12:00:38 UTC","updated_at":"2021-04-20 12:00:38 UTC","ancestry":null,"parent_id":null,"parent_name":null,"id":5,"name":"Test + Organization One","title":"Test Organization One","users":[],"smart_proxies":[],"subnets":[],"compute_resources":[],"media":[],"ptables":[{"description":null,"os_family":"Coreos","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"CoreOS default + fake","id":114,"inherited":false},{"description":null,"os_family":"Rancheros","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"Empty","id":115,"inherited":false},{"description":null,"os_family":"Freebsd","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"FreeBSD default + fake","id":116,"inherited":false},{"description":null,"os_family":"Solaris","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"Jumpstart default","id":117,"inherited":false},{"description":null,"os_family":"Solaris","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"Jumpstart mirrored","id":118,"inherited":false},{"description":null,"os_family":"Junos","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"Junos default + fake","id":119,"inherited":false},{"description":null,"os_family":"Suse","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"AutoYaST entire + SCSI disk","id":111,"inherited":false},{"description":null,"os_family":"Suse","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"AutoYaST entire + virtual disk","id":112,"inherited":false},{"description":null,"os_family":"Suse","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"AutoYaST LVM","id":113,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"Kickstart custom","id":120,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Kickstart default","id":121,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Kickstart default + thin","id":122,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Kickstart dynamic","id":123,"inherited":false},{"description":null,"os_family":"NXOS","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"NX-OS default + fake","id":124,"inherited":false},{"description":null,"os_family":"Debian","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Preseed default","id":125,"inherited":false},{"description":null,"os_family":"Debian","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Preseed default + LVM","id":126,"inherited":false},{"description":null,"os_family":"Windows","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Windows default + partition table","id":127,"inherited":false},{"description":null,"os_family":"Windows","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Windows default + GPT EFI partition table","id":128,"inherited":false},{"description":null,"os_family":"Xenserver","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"XenServer default","id":129,"inherited":false}],"provisioning_templates":[{"id":1,"name":"NX-OS + default POAP setup","template_kind_id":10,"template_kind_name":"POAP","inherited":false},{"id":2,"name":"Jumpstart + default PXEGrub","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":3,"name":"Kickstart + default PXEGrub","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":4,"name":"PXEGrub + default local boot","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":5,"name":"PXEGrub + global default","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":6,"name":"Kickstart + default PXEGrub2","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":7,"name":"Preseed + default PXEGrub2","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":8,"name":"PXEGrub2 + default local boot","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":9,"name":"PXEGrub2 + global default","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":10,"name":"Alterator + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":11,"name":"AutoYaST + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":12,"name":"CoreOS + PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":13,"name":"FreeBSD + (mfsBSD) PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":14,"name":"Kickstart + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":15,"name":"Kickstart + oVirt-RHVH PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":16,"name":"Preseed + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":17,"name":"PXELinux + chain iPXE","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":18,"name":"PXELinux + chain iPXE UNDI","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":19,"name":"PXELinux + default local boot","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":20,"name":"PXELinux + default memdisk","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":21,"name":"PXELinux + global default","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":22,"name":"RancherOS + PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":23,"name":"WAIK + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":24,"name":"Windows + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":25,"name":"XenServer + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":26,"name":"Junos + default ZTP config","template_kind_id":9,"template_kind_name":"ZTP","inherited":false},{"id":27,"name":"CloudInit + default","template_kind_id":11,"template_kind_name":"cloud-init","inherited":false},{"id":28,"name":"Alterator + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":29,"name":"FreeBSD + (mfsBSD) finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":30,"name":"Jumpstart + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":31,"name":"Junos + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":32,"name":"Kickstart + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":33,"name":"Preseed + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":34,"name":"Windows + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":35,"name":"XenServer + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":36,"name":"AutoYaST + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":37,"name":"iPXE + default local boot","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":38,"name":"iPXE + global default","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":39,"name":"iPXE + intermediate script","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":40,"name":"Kickstart + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":41,"name":"Preseed + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":42,"name":"Windows + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":43,"name":"Alterator + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":44,"name":"Atomic + Kickstart default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":45,"name":"AutoYaST + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":46,"name":"AutoYaST + SLES default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":47,"name":"CoreOS + provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":48,"name":"FreeBSD + (mfsBSD) provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":49,"name":"Jumpstart + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":50,"name":"Junos + default SLAX","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":51,"name":"Kickstart + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":52,"name":"Kickstart + oVirt-RHVH","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":53,"name":"Preseed + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":54,"name":"RancherOS + provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":55,"name":"Windows + default provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":56,"name":"XenServer + default answerfile","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":57,"name":"Global + Registration","template_kind_id":12,"template_kind_name":"registration","inherited":false},{"id":58,"name":"Linux + registration default","template_kind_id":12,"template_kind_name":"registration","inherited":false},{"id":59,"name":"Grubby + default","template_kind_id":7,"template_kind_name":"script","inherited":false},{"id":60,"name":"Windows + peSetup.cmd","template_kind_id":7,"template_kind_name":"script","inherited":false},{"id":61,"name":"alterator_pkglist","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":62,"name":"yum_proxy","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":63,"name":"ansible_provisioning_callback","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":64,"name":"ansible_tower_callback_script","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":65,"name":"ansible_tower_callback_service","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":66,"name":"blacklist_kernel_modules","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":67,"name":"bmc_nic_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":68,"name":"built","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":69,"name":"chef_client","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":70,"name":"coreos_cloudconfig","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":71,"name":"create_users","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":72,"name":"csr_attributes.yaml","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":73,"name":"efibootmgr_netboot","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":74,"name":"eject_cdrom","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":75,"name":"epel","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":76,"name":"fips_packages","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":77,"name":"fix_hosts","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":78,"name":"freeipa_register","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":79,"name":"http_proxy","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":80,"name":"insights","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":81,"name":"kickstart_ifcfg_bond_interface","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":82,"name":"schedule_reboot","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":83,"name":"kickstart_ifcfg_bonded_interface","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":84,"name":"kickstart_ifcfg_generic_interface","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":85,"name":"Windows + network","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":86,"name":"kickstart_ifcfg_get_identifier_names","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":87,"name":"kickstart_kernel_options","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":88,"name":"kickstart_networking_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":89,"name":"ntp","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":96,"name":"pxegrub2_mac","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":90,"name":"preseed_networking_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":91,"name":"puppet.conf","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":92,"name":"puppet_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":93,"name":"puppetlabs_repo","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":94,"name":"pxegrub2_chainload","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":95,"name":"pxegrub2_discovery","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":97,"name":"pxegrub_chainload","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":98,"name":"pxegrub_discovery","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":99,"name":"pxelinux_chainload","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":100,"name":"pxelinux_discovery","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":101,"name":"rancheros_cloudconfig","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":102,"name":"redhat_register","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":103,"name":"remote_execution_ssh_keys","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":104,"name":"saltstack_minion","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":105,"name":"saltstack_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":106,"name":"AutoYaST + default user data","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":107,"name":"Kickstart + default user data","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":108,"name":"Preseed + default user data","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":109,"name":"UserData + default","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":110,"name":"UserData + open-vm-tools","template_kind_id":8,"template_kind_name":"user_data","inherited":false}],"domains":[],"realms":[],"environments":[],"hostgroups":[],"locations":[{"id":2,"name":"Default + Location","title":"Default Location","description":null}],"hosts_count":0,"parameters":[]}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/test_playbooks/fixtures/organizations_role-1.yml b/tests/test_playbooks/fixtures/organizations_role-1.yml new file mode 100644 index 00000000..0f473a69 --- /dev/null +++ b/tests/test_playbooks/fixtures/organizations_role-1.yml @@ -0,0 +1,274 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.0","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/organizations?search=name%3D%22Test+Organization+Two%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 0,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization Two\\\"\",\n \"\ + sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\": []\n\ + }\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '187' + status: + code: 200 + message: OK +- request: + body: '{"organization": {"name": "Test Organization Two", "description": "Two + Two Two"}}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '81' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/api/organizations + response: + body: + string: '{"select_all_types":[],"description":"Two Two Two","created_at":"2021-04-20 + 12:00:39 UTC","updated_at":"2021-04-20 12:00:39 UTC","ancestry":null,"parent_id":null,"parent_name":null,"id":6,"name":"Test + Organization Two","title":"Test Organization Two","users":[],"smart_proxies":[],"subnets":[],"compute_resources":[],"media":[],"ptables":[{"description":null,"os_family":"Coreos","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"CoreOS default + fake","id":114,"inherited":false},{"description":null,"os_family":"Rancheros","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"Empty","id":115,"inherited":false},{"description":null,"os_family":"Freebsd","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"FreeBSD default + fake","id":116,"inherited":false},{"description":null,"os_family":"Solaris","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"Jumpstart default","id":117,"inherited":false},{"description":null,"os_family":"Solaris","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"Jumpstart mirrored","id":118,"inherited":false},{"description":null,"os_family":"Junos","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"Junos default + fake","id":119,"inherited":false},{"description":null,"os_family":"Suse","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"AutoYaST entire + SCSI disk","id":111,"inherited":false},{"description":null,"os_family":"Suse","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"AutoYaST entire + virtual disk","id":112,"inherited":false},{"description":null,"os_family":"Suse","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"AutoYaST LVM","id":113,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-04-20 + 11:33:40 UTC","updated_at":"2021-04-20 11:33:40 UTC","name":"Kickstart custom","id":120,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Kickstart default","id":121,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Kickstart default + thin","id":122,"inherited":false},{"description":null,"os_family":"Redhat","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Kickstart dynamic","id":123,"inherited":false},{"description":null,"os_family":"NXOS","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"NX-OS default + fake","id":124,"inherited":false},{"description":null,"os_family":"Debian","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Preseed default","id":125,"inherited":false},{"description":null,"os_family":"Debian","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Preseed default + LVM","id":126,"inherited":false},{"description":null,"os_family":"Windows","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Windows default + partition table","id":127,"inherited":false},{"description":null,"os_family":"Windows","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"Windows default + GPT EFI partition table","id":128,"inherited":false},{"description":null,"os_family":"Xenserver","created_at":"2021-04-20 + 11:33:41 UTC","updated_at":"2021-04-20 11:33:41 UTC","name":"XenServer default","id":129,"inherited":false}],"provisioning_templates":[{"id":1,"name":"NX-OS + default POAP setup","template_kind_id":10,"template_kind_name":"POAP","inherited":false},{"id":2,"name":"Jumpstart + default PXEGrub","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":3,"name":"Kickstart + default PXEGrub","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":4,"name":"PXEGrub + default local boot","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":5,"name":"PXEGrub + global default","template_kind_id":2,"template_kind_name":"PXEGrub","inherited":false},{"id":6,"name":"Kickstart + default PXEGrub2","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":7,"name":"Preseed + default PXEGrub2","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":8,"name":"PXEGrub2 + default local boot","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":9,"name":"PXEGrub2 + global default","template_kind_id":3,"template_kind_name":"PXEGrub2","inherited":false},{"id":10,"name":"Alterator + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":11,"name":"AutoYaST + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":12,"name":"CoreOS + PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":13,"name":"FreeBSD + (mfsBSD) PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":14,"name":"Kickstart + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":15,"name":"Kickstart + oVirt-RHVH PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":16,"name":"Preseed + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":17,"name":"PXELinux + chain iPXE","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":18,"name":"PXELinux + chain iPXE UNDI","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":19,"name":"PXELinux + default local boot","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":20,"name":"PXELinux + default memdisk","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":21,"name":"PXELinux + global default","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":22,"name":"RancherOS + PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":23,"name":"WAIK + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":24,"name":"Windows + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":25,"name":"XenServer + default PXELinux","template_kind_id":1,"template_kind_name":"PXELinux","inherited":false},{"id":26,"name":"Junos + default ZTP config","template_kind_id":9,"template_kind_name":"ZTP","inherited":false},{"id":27,"name":"CloudInit + default","template_kind_id":11,"template_kind_name":"cloud-init","inherited":false},{"id":28,"name":"Alterator + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":29,"name":"FreeBSD + (mfsBSD) finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":30,"name":"Jumpstart + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":31,"name":"Junos + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":32,"name":"Kickstart + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":33,"name":"Preseed + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":34,"name":"Windows + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":35,"name":"XenServer + default finish","template_kind_id":6,"template_kind_name":"finish","inherited":false},{"id":36,"name":"AutoYaST + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":37,"name":"iPXE + default local boot","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":38,"name":"iPXE + global default","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":39,"name":"iPXE + intermediate script","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":40,"name":"Kickstart + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":41,"name":"Preseed + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":42,"name":"Windows + default iPXE","template_kind_id":4,"template_kind_name":"iPXE","inherited":false},{"id":43,"name":"Alterator + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":44,"name":"Atomic + Kickstart default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":45,"name":"AutoYaST + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":46,"name":"AutoYaST + SLES default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":47,"name":"CoreOS + provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":48,"name":"FreeBSD + (mfsBSD) provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":49,"name":"Jumpstart + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":50,"name":"Junos + default SLAX","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":51,"name":"Kickstart + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":52,"name":"Kickstart + oVirt-RHVH","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":53,"name":"Preseed + default","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":54,"name":"RancherOS + provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":55,"name":"Windows + default provision","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":56,"name":"XenServer + default answerfile","template_kind_id":5,"template_kind_name":"provision","inherited":false},{"id":57,"name":"Global + Registration","template_kind_id":12,"template_kind_name":"registration","inherited":false},{"id":58,"name":"Linux + registration default","template_kind_id":12,"template_kind_name":"registration","inherited":false},{"id":59,"name":"Grubby + default","template_kind_id":7,"template_kind_name":"script","inherited":false},{"id":60,"name":"Windows + peSetup.cmd","template_kind_id":7,"template_kind_name":"script","inherited":false},{"id":61,"name":"alterator_pkglist","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":62,"name":"yum_proxy","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":63,"name":"ansible_provisioning_callback","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":64,"name":"ansible_tower_callback_script","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":65,"name":"ansible_tower_callback_service","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":66,"name":"blacklist_kernel_modules","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":67,"name":"bmc_nic_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":68,"name":"built","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":69,"name":"chef_client","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":70,"name":"coreos_cloudconfig","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":71,"name":"create_users","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":72,"name":"csr_attributes.yaml","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":73,"name":"efibootmgr_netboot","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":74,"name":"eject_cdrom","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":75,"name":"epel","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":76,"name":"fips_packages","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":77,"name":"fix_hosts","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":78,"name":"freeipa_register","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":79,"name":"http_proxy","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":80,"name":"insights","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":81,"name":"kickstart_ifcfg_bond_interface","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":82,"name":"schedule_reboot","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":83,"name":"kickstart_ifcfg_bonded_interface","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":84,"name":"kickstart_ifcfg_generic_interface","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":85,"name":"Windows + network","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":86,"name":"kickstart_ifcfg_get_identifier_names","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":87,"name":"kickstart_kernel_options","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":88,"name":"kickstart_networking_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":89,"name":"ntp","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":96,"name":"pxegrub2_mac","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":90,"name":"preseed_networking_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":91,"name":"puppet.conf","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":92,"name":"puppet_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":93,"name":"puppetlabs_repo","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":94,"name":"pxegrub2_chainload","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":95,"name":"pxegrub2_discovery","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":97,"name":"pxegrub_chainload","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":98,"name":"pxegrub_discovery","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":99,"name":"pxelinux_chainload","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":100,"name":"pxelinux_discovery","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":101,"name":"rancheros_cloudconfig","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":102,"name":"redhat_register","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":103,"name":"remote_execution_ssh_keys","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":104,"name":"saltstack_minion","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":105,"name":"saltstack_setup","template_kind_id":null,"template_kind_name":null,"inherited":false},{"id":106,"name":"AutoYaST + default user data","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":107,"name":"Kickstart + default user data","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":108,"name":"Preseed + default user data","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":109,"name":"UserData + default","template_kind_id":8,"template_kind_name":"user_data","inherited":false},{"id":110,"name":"UserData + open-vm-tools","template_kind_id":8,"template_kind_name":"user_data","inherited":false}],"domains":[],"realms":[],"environments":[],"hostgroups":[],"locations":[{"id":2,"name":"Default + Location","title":"Default Location","description":null}],"hosts_count":0,"parameters":[]}' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/test_playbooks/organizations_role.yml b/tests/test_playbooks/organizations_role.yml new file mode 100644 index 00000000..499ab977 --- /dev/null +++ b/tests/test_playbooks/organizations_role.yml @@ -0,0 +1,46 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: drop existing test orgs + include_tasks: tasks/organization.yml + vars: + organization_name: "{{ item }}" + organization_state: "absent" + loop: + - "Test Organization One" + - "Test Organization Two" + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + roles: + - role: organizations + vars: + foreman_organizations: + - name: "Test Organization One" + - name: "Test Organization Two" + description: "Two Two Two" + +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: drop existing test orgs + include_tasks: tasks/organization.yml + vars: + organization_name: "{{ item }}" + organization_state: "absent" + loop: + - "Test Organization One" + - "Test Organization Two" From b73dd0f13d5ce67009de18817e8bde069e5ba2af Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Tue, 20 Apr 2021 14:06:04 +0200 Subject: [PATCH 35/56] add changelog --- changelogs/fragments/1109-organizations-role.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelogs/fragments/1109-organizations-role.yml diff --git a/changelogs/fragments/1109-organizations-role.yml b/changelogs/fragments/1109-organizations-role.yml new file mode 100644 index 00000000..7d307e73 --- /dev/null +++ b/changelogs/fragments/1109-organizations-role.yml @@ -0,0 +1,2 @@ +minor_changes: + - new ``organizations`` role to manage organizations (https://github.com/theforeman/foreman-ansible-modules/issues/1109) From ae1610a0c37a346fa10990a33b3135ca033f2fa7 Mon Sep 17 00:00:00 2001 From: Adam Ruzicka Date: Thu, 22 Apr 2021 12:45:15 +0200 Subject: [PATCH 36/56] Drop requests version check in foreman callback Before this commit we briefly required to have requests >=2.14 by mistake. FAM already requires requests >=2.4.2 which should contain everything the callback needs. --- plugins/callback/foreman.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/plugins/callback/foreman.py b/plugins/callback/foreman.py index 37e50ed2..942d9681 100644 --- a/plugins/callback/foreman.py +++ b/plugins/callback/foreman.py @@ -159,11 +159,7 @@ def set_options(self, task_keys=None, var_options=None, direct=None): ssl_cert = self.get_option('client_cert') ssl_key = self.get_option('client_key') - if HAS_REQUESTS: - requests_version = tuple(map(int, requests.__version__.split('.'))) - if requests_version < (2, 14): - self._disable_plugin(u'The `requests` python module is older than 2.14.0.') - else: + if not HAS_REQUESTS: self._disable_plugin(u'The `requests` python module is not installed') if self.foreman_url.startswith('https://'): From 951c394419d0de918db14ec4e3d87c4352fe7b13 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Fri, 23 Apr 2021 09:45:08 +0200 Subject: [PATCH 37/56] update Katello apidoc to 4.0 --- tests/fixtures/apidoc/katello.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/fixtures/apidoc/katello.json b/tests/fixtures/apidoc/katello.json index 92535092..56c01027 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":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"DELETE","short_description":"Unregister the host as a subscription consumer","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/create","name":"create","apis":[{"api_url":"/api/hosts/subscriptions","http_method":"POST","short_description":"Register a host with subscription and information","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eUUID to use for registered host, random uuid is generated if not provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003eKey-value hash of subscription-manager facts, nesting uses a period\ndelimiter (.)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"hypervisor_guest_uuids","description":"\n\u003cp\u003eUUIDs of the virtual guests from the host\u0026#39;s hypervisor\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products","full_name":"installed_products","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"installed_products[product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"installed_products[product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"installed_products[arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"installed_products[version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003eRelease version of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eA service level for auto-healing process, e.g. SELF-SUPPORT\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"lifecycle_environment_id","description":"\n\u003cp\u003eLifecycle Environment ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent View ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/remove_subscriptions","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eIf specified, remove the first instance of a subscription with matching id\nand quantity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/add_subscriptions","http_method":"PUT","short_description":"Add a subscription to a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/content_override","name":"content_override","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/content_override","http_method":"PUT","short_description":"Set content overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n\u003cp\u003eOverride to a boolean value or \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be\n\u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/product_content","name":"product_content","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/product_content","http_method":"GET","short_description":"Get content and overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the host\u0026#39;s content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/available_release_versions","name":"available_release_versions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/available_release_versions","http_method":"GET","short_description":"Show releases available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"interfaces":{"doc_url":"../apidoc/v2/interfaces","id":"interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"GET","short_description":"Show an interface for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subnets":{"doc_url":"../apidoc/v2/subnets","id":"subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/create","name":"create","apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hosts":{"doc_url":"../apidoc/v2/hosts","id":"hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null},{"api_url":"/api/environments/:environment_id/hosts","http_method":"GET","short_description":"List hosts per environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"activation_key","type":"string"},{"name":"activation_key_id","type":"string"},{"name":"addon","type":"string"},{"name":"addons_status","values":["mismatched","matched","not_specified"]},{"name":"applicable_errata","type":"string"},{"name":"applicable_errata_issued","type":"date"},{"name":"applicable_rpms","type":"string"},{"name":"architecture","type":"string"},{"name":"autoheal","type":"boolean"},{"name":"available_module_stream_name","type":"string"},{"name":"available_module_stream_stream","type":"string"},{"name":"boot_time","type":""},{"name":"build","values":["true","false"]},{"name":"class","type":"string"},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"config_group","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"created_at","type":"datetime"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"environment","type":"string"},{"name":"errata_status","values":["security_needed","errata_needed","updated","unknown"]},{"name":"execution_status","values":["ok","error"]},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","type":"string"},{"name":"has_mac","type":"string"},{"name":"host_collection","type":"string"},{"name":"host_collection_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_id","type":"integer"},{"name":"hostgroup_name","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"hypervisor","type":"boolean"},{"name":"hypervisor_host","type":"string"},{"name":"image","type":"string"},{"name":"installable_errata","type":"string"},{"name":"installed_at","type":"datetime"},{"name":"installed_package","type":"string"},{"name":"installed_package_name","type":"string"},{"name":"ip","type":"string"},{"name":"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_environment","type":"string"},{"name":"lifecycle_environment_id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mac","type":"string"},{"name":"managed","values":["true","false"]},{"name":"model","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"owner","type":"string"},{"name":"owner_id","type":"integer"},{"name":"owner_type","type":"string"},{"name":"params","type":"string"},{"name":"params_name","type":"string"},{"name":"parent_hostgroup","type":"string"},{"name":"pools_expiring_in_days","type":"string"},{"name":"puppet_ca","type":"string"},{"name":"puppet_proxy_id","type":"integer"},{"name":"puppetmaster","type":"string"},{"name":"purpose_status","values":["mismatched","matched","not_specified"]},{"name":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"name":"registered_at","type":"datetime"},{"name":"registered_through","type":"string"},{"name":"release_version","type":"string"},{"name":"role","type":"text"},{"name":"role_status","values":["mismatched","matched","not_specified"]},{"name":"service_level","type":"string"},{"name":"sla_status","values":["mismatched","matched","not_specified"]},{"name":"smart_proxy","type":"string"},{"name":"status.applied","type":"integer"},{"name":"status.enabled","values":["true","false"]},{"name":"status.failed","type":"integer"},{"name":"status.failed_restarts","type":"integer"},{"name":"status.interesting","values":["true","false"]},{"name":"status.pending","type":"integer"},{"name":"status.restarted","type":"integer"},{"name":"status.skipped","type":"integer"},{"name":"subnet","type":"string"},{"name":"subnet.name","type":"text"},{"name":"subnet6","type":"string"},{"name":"subnet6.name","type":"text"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"subscription_status","values":["valid","partial","invalid","unknown","disabled","unsubscribed_hypervisor"]},{"name":"subscription_uuid","type":"string"},{"name":"trace_app","type":"string"},{"name":"trace_app_type","type":"string"},{"name":"trace_helper","type":"string"},{"name":"trace_status","values":["reboot_needed","process_restart_needed","updated"]},{"name":"upgradable_rpms","type":"string"},{"name":"usage","type":"text"},{"name":"usage_status","values":["mismatched","matched","not_specified"]},{"name":"user.firstname","type":"string"},{"name":"user.lastname","type":"string"},{"name":"user.login","type":"string"},{"name":"user.mail","type":"string"},{"name":"usergroup","type":"string"},{"name":"usergroup.name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/show","name":"show","apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/enc","name":"enc","apis":[{"api_url":"/api/hosts/:id/enc","http_method":"GET","short_description":"Get ENC values of host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eglobal\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003econfiguration\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ebuild\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host\u0026#39;s compute attributes that can be used to create a clone\nof this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot),\n(cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host,\nContent_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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE,\nprovision, finish, script, user_data, ZTP, POAP, cloud-init, registration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/host_collections","name":"host_collections","apis":[{"api_url":"/api/hosts/:host_id/host_collections","http_method":"PUT","short_description":"Alter a hosts host collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eThe id of the host to alter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","id":"hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/hostgroups","http_method":"GET","short_description":"List all host groups for a Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"class","type":"string"},{"name":"config_group","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/create","name":"create","apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/update","name":"update","apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/clone","name":"clone","apis":[{"api_url":"/api/hostgroups/:id/clone","http_method":"POST","short_description":"Clone a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host,\nContent_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":[]},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","id":"smart_proxies","api_url":"/api","name":"Smart proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/create","name":"create","apis":[{"api_url":"/api/smart_proxies","http_method":"POST","short_description":"Create a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/update","name":"update","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"PUT","short_description":"Update a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"DELETE","short_description":"Delete a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"../apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template inputs","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"POST","short_description":"Create a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::GpgKey\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"PUT","short_description":"Update a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::GpgKey\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"architectures":{"doc_url":"../apidoc/v2/architectures","id":"architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","id":"template_kinds","api_url":"/api","name":"Template kinds","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"../apidoc/v2/audits","id":"audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"action","type":"string"},{"name":"auditable_id","type":"integer"},{"name":"changes","type":"text"},{"name":"comment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"interface_fqdn","type":"string"},{"name":"interface_ip","type":"string"},{"name":"interface_mac","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_title","type":"string"},{"name":"parameter","type":"string"},{"name":"partition_table","type":"string"},{"name":"provisioning_template","type":"string"},{"name":"puppetclass","type":"string"},{"name":"remote_address","type":"string"},{"name":"request_uuid","type":"string"},{"name":"setting","type":"string"},{"name":"time","type":"datetime"},{"name":"type","values":["role","ptable","provisioning_template","user","filter","architecture","bookmark","compute_profile","config_group","domain","environment","host_class","hostgroup","http_proxy","image","key_pair","medium","model","personal_access_token","report_template","puppetclass","realm","smart_proxy","ssh_key","subnet","usergroup","job_template","job_invocation","remote_execution_feature","katello/repository","katello/host/content_facet","katello/hostgroup/content_facet","katello/host/subscription_facet","katello/activation_key","katello/content_view","katello/gpg_key","katello/host_collection","katello/kt_environment","katello/product","katello/sync_plan","lookup_value","hostgroup_class","auth_source","compute_resource","host","interface","location","organization","os","override_value","parameter","partition_table","setting","smart_class_parameter"]},{"name":"user","type":"string"},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"../apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal access tokens","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"../apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth source externals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/update","name":"update","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"PUT","short_description":"Update an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ping":{"doc_url":"../apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/index","name":"index","apis":[{"api_url":"/katello/api/ping","http_method":"GET","short_description":"Shows status of Katello system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/server_status","name":"server_status","apis":[{"api_url":"/katello/api/status","http_method":"GET","short_description":"Shows version information","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"auth_source_internals":{"doc_url":"../apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth source internals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"plugins":{"doc_url":"../apidoc/v2/plugins","id":"plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","id":"auth_source_ldaps","api_url":"/api","name":"Auth source ldaps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/create","name":"create","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"POST","short_description":"Create an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"trends":{"doc_url":"../apidoc/v2/trends","id":"trends","api_url":"/api","name":"Trends","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API enpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/trends/index","name":"index","apis":[{"api_url":"/api/trends","http_method":"GET","short_description":"List of trends counters","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/show","name":"show","apis":[{"api_url":"/api/trends/:id","http_method":"GET","short_description":"Show a trend","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/create","name":"create","apis":[{"api_url":"/api/trends","http_method":"POST","short_description":"Create a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/destroy","name":"destroy","apis":[{"api_url":"/api/trends/:id","http_method":"DELETE","short_description":"Delete a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"auth_sources":{"doc_url":"../apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth sources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","id":"usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the Foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"autosign":{"doc_url":"../apidoc/v2/autosign","id":"autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"../apidoc/v2/users","id":"users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"last_login_on","type":"datetime"},{"name":"lastname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"login","type":"string"},{"name":"mail","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"usergroup","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user if it is not already present.\nOnly another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","id":"bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/create","name":"create","apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"environment","type":"string"},{"name":"hostgroup","type":"string"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/create","name":"create","apis":[{"api_url":"/api/provisioning_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/build_pxe_default","name":"build_pxe_default","apis":[{"api_url":"/api/provisioning_templates/build_pxe_default","http_method":"POST","short_description":"Update the default PXE menu on all configured TFTP servers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/global_registration","name":"global_registration","apis":[{"api_url":"/api/register","http_method":"GET","short_description":"Render Global Registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","id":"common_parameters","api_url":"/api","name":"Common parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/create","name":"create","apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"../apidoc/v2/ptables","id":"ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/create","name":"create","apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","id":"compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","id":"puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"key","type":"string"},{"name":"location","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","id":"compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/create","name":"create","apis":[{"api_url":"/api/compute_profiles","http_method":"POST","short_description":"Create a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_hosts":{"doc_url":"../apidoc/v2/puppet_hosts","id":"puppet_hosts","api_url":"/api","name":"Puppet hosts","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Remote Execution Plugin.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nRemote Execution Plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","id":"compute_resources","api_url":"/api","name":"Compute resources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show","name":"show","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/create","name":"create","apis":[{"api_url":"/api/compute_resources","http_method":"POST","short_description":"Create a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_images","name":"available_images","apis":[{"api_url":"/api/compute_resources/:id/available_images","http_method":"GET","short_description":"List available images for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_clusters","name":"available_clusters","apis":[{"api_url":"/api/compute_resources/:id/available_clusters","http_method":"GET","short_description":"List available clusters for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_flavors","name":"available_flavors","apis":[{"api_url":"/api/compute_resources/:id/available_flavors","http_method":"GET","short_description":"List available flavors for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_folders","name":"available_folders","apis":[{"api_url":"/api/compute_resources/:id/available_folders","http_method":"GET","short_description":"List available folders for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_zones","name":"available_zones","apis":[{"api_url":"/api/compute_resources/:id/available_zones","http_method":"GET","short_description":"List available zone for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_networks","name":"available_networks","apis":[{"api_url":"/api/compute_resources/:id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/refresh_cache","name":"refresh_cache","apis":[{"api_url":"/api/compute_resources/:id/refresh_cache","http_method":"PUT","short_description":"Refresh Compute Resource Cache","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_virtual_machines","name":"available_virtual_machines","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines","http_method":"GET","short_description":"List available virtual machines for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show_vm","name":"show_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"GET","short_description":"Show a virtual machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/power_vm","name":"power_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id/power","http_method":"PUT","short_description":"Power a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy_vm","name":"destroy_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"DELETE","short_description":"Delete a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_groups":{"doc_url":"../apidoc/v2/config_groups","id":"config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"class","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"../apidoc/v2/realms","id":"realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/create","name":"create","apis":[{"api_url":"/api/realms","http_method":"POST","short_description":"Create a realm","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003ename\u003c/strong\u003e field is used for the name of the realm.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"environment","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/create","name":"create","apis":[{"api_url":"/api/config_reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","id":"dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"../apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are of the form\n\u003cem\u003ehostname\u003c/em\u003e.\u003cstrong\u003esomewhere.com\u003c/strong\u003e then the domain is\n\u003cstrong\u003esomewhere.com\u003c/strong\u003e. This allows Foreman to associate a puppet\nvariable with a domain/site and automatically append this variable to all\nexternal node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003efullname\u003c/strong\u003e field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"environments":{"doc_url":"../apidoc/v2/environments","id":"environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/environments","http_method":"GET","short_description":"List environments of Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/environments","http_method":"GET","short_description":"List environments per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"../apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/create","name":"create","apis":[{"api_url":"/api/report_templates","http_method":"POST","short_description":"Create a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/generate","name":"generate","apis":[{"api_url":"/api/report_templates/:id/generate","http_method":"POST","short_description":"Generate report from a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action\nreturns an url to get resulting report from (see\n\u003cstrong\u003ereport_data\u003c/strong\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use \u0026#39;,\u0026#39; to\nseparate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API\nendpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is\ndelivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn\u0026#39;t\nbeen generated yet, it will return an empty response with http status 204 -\nNoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","id":"external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","id":"fact_values","api_url":"/api","name":"Fact values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/create","name":"create","apis":[{"api_url":"/api/filters","http_method":"POST","short_description":"Create a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"../apidoc/v2/home","id":"home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_classes":{"doc_url":"../apidoc/v2/host_classes","id":"host_classes","api_url":"/api","name":"Host classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_classes/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"../apidoc/v2/roles","id":"roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroup_classes":{"doc_url":"../apidoc/v2/hostgroup_classes","id":"hostgroup_classes","api_url":"/api","name":"Hostgroup classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroup_classes/index","name":"index","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/create","name":"create","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"../apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/create","name":"create","apis":[{"api_url":"/api/http_proxies","http_method":"POST","short_description":"Create an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"../apidoc/v2/images","id":"images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"../apidoc/v2/locations","id":"locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/show","name":"show","apis":[{"api_url":"/api/locations/:id","http_method":"GET","short_description":"Show a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/create","name":"create","apis":[{"api_url":"/api/locations","http_method":"POST","short_description":"Create a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"../apidoc/v2/settings","id":"settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/create","name":"create","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"POST","short_description":"Add an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"../apidoc/v2/media","id":"media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/create","name":"create","apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"../apidoc/v2/models","id":"models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/create","name":"create","apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"../apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","id":"operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"../apidoc/v2/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/katello/api/organizations","http_method":"GET","short_description":"List all organizations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"GET","short_description":"Show organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/katello/api/organizations","http_method":"POST","short_description":"Create organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"PUT","short_description":"Update organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"redhat_repository_url","full_name":"redhat_repository_url","description":"\n\u003cp\u003eRed Hat CDN URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/repo_discover","name":"repo_discover","apis":[{"api_url":"/katello/api/organizations/:id/repo_discover","http_method":"PUT","short_description":"Discover Repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003eBase URL to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eOne of yum or docker\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch pattern (defaults to \u0026#39;*\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/cancel_repo_discover","name":"cancel_repo_discover","apis":[{"api_url":"/katello/api/organizations/:label/cancel_repo_discover","http_method":"PUT","short_description":"Cancel repository discovery","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003ebase url to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/download_debug_certificate","name":"download_debug_certificate","apis":[{"api_url":"/katello/api/organizations/:label/download_debug_certificate","http_method":"GET","short_description":"Download a debug certificate","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/releases","name":"releases","apis":[{"api_url":"/katello/api/organizations/:id/releases","http_method":"GET","short_description":"List available releases in the organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the Organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/redhat_provider","name":"redhat_provider","apis":[{"api_url":"/katello/api/organizations/:id/redhat_provider","http_method":"GET","short_description":"List all :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tasks":{"doc_url":"../apidoc/v2/tasks","id":"tasks","api_url":"/api","name":"Tasks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","id":"os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"GET","short_description":"Show a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","id":"template_combinations","api_url":"/api","name":"Template combinations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"override_values":{"doc_url":"../apidoc/v2/override_values","id":"override_values","api_url":"/api","name":"Override values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/override_values/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"../apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cstrong\u003enested parameters for a host,\ndomain, subnet, host group, operating system\u003c/strong\u003e. If you are looking\nfor \u0026lt;a href=“common_parameters.html”\u0026gt;global parameters\u0026lt;/a\u0026gt;, go\nto \u0026lt;a href=“common_parameters.html”\u0026gt;this link\u0026lt;/a\u0026gt;.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"../apidoc/v2/permissions","id":"permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/resource_types","name":"resource_types","apis":[{"api_url":"/api/permissions/resource_types","http_method":"GET","short_description":"List available resource types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_class_parameters":{"doc_url":"../apidoc/v2/smart_class_parameters","id":"smart_class_parameters","api_url":"/api","name":"Smart class parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_class_parameters/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters","http_method":"GET","short_description":"List all smart class parameters","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment/Puppet class combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"avoid_duplicates","values":["true","false"]},{"name":"environment","type":"string"},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"},{"name":"puppetclass","type":"string"},{"name":"puppetclass_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"GET","short_description":"Show a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"PUT","short_description":"Update a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"\n\u003cp\u003eWhether the smart class parameter value is managed by Foreman\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003cp\u003eDescription of smart class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"\n\u003cp\u003eValue to use when there is no match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"smart_class_parameter[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"smart_class_parameter[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output. Puppet will\nuse the value defined in the Puppet manifest for this parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"smart_class_parameter[path]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"smart_class_parameter[required]","description":"\n\u003cp\u003eIf true, will raise an error if there is no default value and no matcher\nprovide a value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"smart_class_parameter[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"smart_class_parameter[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"smart_class_parameter[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"../apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"statistics":{"doc_url":"../apidoc/v2/statistics","id":"statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API endpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install the\nForeman Statistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"recurring_logics":{"doc_url":"../apidoc/v2/recurring_logics","id":"recurring_logics","api_url":"/api","name":"Recurring logics","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/recurring_logics/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/recurring_logics","http_method":"GET","short_description":"List recurring logics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"GET","short_description":"Show recurring logic details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/update","name":"update","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"PUT","short_description":"Update recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eWhether the recurring logic is enabled or disabled.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/cancel","name":"cancel","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id/cancel","http_method":"POST","short_description":"Cancel recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/bulk_destroy","name":"bulk_destroy","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/bulk_destroy","http_method":"POST","short_description":"Delete recurring logics by search query","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch query\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreman_tasks":{"doc_url":"../apidoc/v2/foreman_tasks","id":"foreman_tasks","api_url":"/api","name":"Foreman tasks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreman_tasks/summary","name":"summary","apis":[{"api_url":"/foreman_tasks/api/tasks/summary","http_method":"GET","short_description":"Show task summary","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/tasks/:id","http_method":"GET","short_description":"Show task details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/details","name":"details","apis":[{"api_url":"/foreman_tasks/api/tasks/:id/details","http_method":"GET","short_description":"Show task extended details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_search","name":"bulk_search","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_search","http_method":"POST","short_description":"List dynflow tasks for uuids","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eFor every search it returns the list of tasks that satisfty the condition.\nThe reason for supporting multiple searches is the UI that might be ending\nneeding periodic updates on task status for various searches at the same\ntime. This way, it is possible to get all the task statuses with one\nrequest.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"searches","full_name":"searches","description":"\n\u003cp\u003eList of uuids to fetch info about\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"search_id","full_name":"searches[search_id]","description":"\n\u003cp\u003eArbitraty value for client to identify the the request parts with results.\nIt\u0026#39;s passed in the results to be able to pair the requests and\nresponses properly.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"searches[type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003eresource\u003c/code\u003e, \u003ccode\u003etask\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_id","full_name":"searches[task_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;task\u0026#39;, find the task by the uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"searches[user_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;user\u0026#39;, find tasks for the user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource type we\u0026#39;re searching\nthe tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource id we\u0026#39;re searching\nthe tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"action_types","full_name":"searches[action_types]","description":"\n\u003cp\u003eReturn just tasks of given action type, e.g.\n[“Actions::Katello::Repository::Synchronize”]\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eString\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active_only","full_name":"searches[active_only]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"searches[page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"searches[per_page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_resume","name":"bulk_resume","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_resume","http_method":"POST","short_description":"Resume all paused error tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eResume tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eResume specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_cancel","name":"bulk_cancel","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_cancel","http_method":"POST","short_description":"Cancel all cancellable tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eCancel tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eCancel specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_stop","name":"bulk_stop","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_stop","http_method":"POST","short_description":"Stop all stoppable tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eStop tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eStop specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/tasks","http_method":"GET","short_description":"List tasks","deprecated":null},{"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/callback","name":"callback","apis":[{"api_url":"/foreman_tasks/api/tasks/callback","http_method":"POST","short_description":"Send data to the task from external executor (such as smart_proxy_dynflow)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"callback","full_name":"callback","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"task_id","full_name":"callback[task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"step_id","full_name":"callback[step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"data","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"callbacks","full_name":"callbacks","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"callback","full_name":"callbacks[callback]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"task_id","full_name":"callbacks[callback][task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"step_id","full_name":"callbacks[callback][step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"callbacks[data]","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreign_input_sets":{"doc_url":"../apidoc/v2/foreign_input_sets","id":"foreign_input_sets","api_url":"/api","name":"Foreign input sets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreign_input_sets/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"GET","short_description":"List foreign input sets","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"GET","short_description":"Show foreign input set details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"POST","short_description":"Create a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"DELETE","short_description":"Delete a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"PUT","short_description":"Update a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_invocations":{"doc_url":"../apidoc/v2/job_invocations","id":"job_invocations","api_url":"/api","name":"Job invocations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/job_invocations/index","name":"index","apis":[{"api_url":"/api/job_invocations","http_method":"GET","short_description":"List job invocations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/show","name":"show","apis":[{"api_url":"/api/job_invocations/:id","http_method":"GET","short_description":"Show job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_status","full_name":"host_status","description":"\n\u003cp\u003eShow Job status for the hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/create","name":"create","apis":[{"api_url":"/api/job_invocations","http_method":"POST","short_description":"Create a job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_invocation","full_name":"job_invocation","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"job_template_id","full_name":"job_invocation[job_template_id]","description":"\n\u003cp\u003eThe job template to use, parameter is required unless feature was specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"targeting_type","full_name":"job_invocation[targeting_type]","description":"\n\u003cp\u003eInvocation type, one of {“static_query”=\u0026gt;“Static Query”,\n“dynamic_query”=\u0026gt;“Dynamic Query”}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"randomized_ordering","full_name":"job_invocation[randomized_ordering]","description":"\n\u003cp\u003eExecute the jobs on hosts in randomized order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inputs","full_name":"job_invocation[inputs]","description":"\n\u003cp\u003eInputs to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"ssh","full_name":"job_invocation[ssh]","description":"\n\u003cp\u003eSSH provider specific options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"effective_user","full_name":"job_invocation[ssh][effective_user]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms).\nDefaults to a template parameter or global setting.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"recurrence","full_name":"job_invocation[recurrence]","description":"\n\u003cp\u003eCreate a recurring job\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"cron_line","full_name":"job_invocation[recurrence][cron_line]","description":"\n\u003cp\u003eHow often the job should occur, in the cron format\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_iteration","full_name":"job_invocation[recurrence][max_iteration]","description":"\n\u003cp\u003eRepeat a maximum of N times\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"end_time","full_name":"job_invocation[recurrence][end_time]","description":"\n\u003cp\u003ePerform no more executions after this time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"scheduling","full_name":"job_invocation[scheduling]","description":"\n\u003cp\u003eSchedule the job to start at a later time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"start_at","full_name":"job_invocation[scheduling][start_at]","description":"\n\u003cp\u003eSchedule the job for a future time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_before","full_name":"job_invocation[scheduling][start_before]","description":"\n\u003cp\u003eIndicates that the action should be cancelled if it cannot be started\nbefore this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"concurrency_control","full_name":"job_invocation[concurrency_control]","description":"\n\u003cp\u003eControl concurrency level and distribution over time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"time_span","full_name":"job_invocation[concurrency_control][time_span]","description":"\n\u003cp\u003eDistribute tasks over N seconds\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"concurrency_level","full_name":"job_invocation[concurrency_control][concurrency_level]","description":"\n\u003cp\u003eRun at most N tasks at a time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"bookmark_id","full_name":"job_invocation[bookmark_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search_query","full_name":"job_invocation[search_query]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_invocation[description_format]","description":"\n\u003cp\u003eOverride the description format from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"execution_timeout_interval","full_name":"job_invocation[execution_timeout_interval]","description":"\n\u003cp\u003eOverride the timeout interval from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"feature","full_name":"job_invocation[feature]","description":"\n\u003cp\u003eRemote execution feature label that should be triggered, job template\nassigned to this feature will be used\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/output","name":"output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id","http_method":"GET","short_description":"Get output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/raw_output","name":"raw_output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id/raw","http_method":"GET","short_description":"Get raw output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/cancel","name":"cancel","apis":[{"api_url":"/api/job_invocations/:id/cancel","http_method":"POST","short_description":"Cancel job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/rerun","name":"rerun","apis":[{"api_url":"/api/job_invocations/:id/rerun","http_method":"POST","short_description":"Rerun job on failed hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"failed_only","full_name":"failed_only","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_templates":{"doc_url":"../apidoc/v2/job_templates","id":"job_templates","api_url":"/api","name":"Job templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/job_templates/index","name":"index","apis":[{"api_url":"/api/job_templates","http_method":"GET","short_description":"List job templates","deprecated":null},{"api_url":"/api/locations/:location_id/job_templates","http_method":"GET","short_description":"List job templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/job_templates","http_method":"GET","short_description":"List job templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/import","name":"import","apis":[{"api_url":"/api/job_templates/import","http_method":"POST","short_description":"Import a job template from ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"template","description":"\n\u003cp\u003eTemplate ERB\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overwrite","full_name":"overwrite","description":"\n\u003cp\u003eOverwrite template if it already exists\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/export","name":"export","apis":[{"api_url":"/api/job_templates/:id/export","http_method":"GET","short_description":"Export a job template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/show","name":"show","apis":[{"api_url":"/api/job_templates/:id","http_method":"GET","short_description":"Show job template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/create","name":"create","apis":[{"api_url":"/api/job_templates","http_method":"POST","short_description":"Create a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"job_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the\ninvocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/update","name":"update","apis":[{"api_url":"/api/job_templates/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"job_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the\ninvocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/revision","name":"revision","apis":[{"api_url":"/api/job_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eTemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/destroy","name":"destroy","apis":[{"api_url":"/api/job_templates/:id","http_method":"DELETE","short_description":"Delete a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/clone","name":"clone","apis":[{"api_url":"/api/job_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"remote_execution_features":{"doc_url":"../apidoc/v2/remote_execution_features","id":"remote_execution_features","api_url":"/api","name":"Remote execution features","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/remote_execution_features/index","name":"index","apis":[{"api_url":"/api/remote_execution_features","http_method":"GET","short_description":"List remote execution features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/remote_execution_features/show","name":"show","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"GET","short_description":"Show remote execution feature","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/remote_execution_features/update","name":"update","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_execution_feature","full_name":"remote_execution_feature","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"job_template_id","full_name":"remote_execution_feature[job_template_id]","description":"\n\u003cp\u003eJob template ID to be used for the feature\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_invocations":{"doc_url":"../apidoc/v2/template_invocations","id":"template_invocations","api_url":"/api","name":"Template invocations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_invocations/template_invocations","name":"template_invocations","apis":[{"api_url":"/api/job_invocations/:job_invocation_id/template_invocations","http_method":"GET","short_description":"List template invocations belonging to job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"job_invocation_id","full_name":"job_invocation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_modules":{"doc_url":"../apidoc/v2/puppet_modules","id":"puppet_modules","api_url":"/api","name":"Puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea puppet module identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/compare","name":"compare","apis":[{"api_url":"/katello/api/puppet_modules/compare","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"activation_keys":{"doc_url":"../apidoc/v2/activation_keys","id":"activation_keys","api_url":"/api","name":"Activation keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/activation_keys/index","name":"index","apis":[{"api_url":"/katello/api/activation_keys","http_method":"GET","short_description":"List activation keys","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eactivation key name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"addon","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"environment","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"usage","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/create","name":"create","apis":[{"api_url":"/katello/api/activation_keys","http_method":"POST","short_description":"Create an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"\n\u003cp\u003eenvironment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/update","name":"update","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"PUT","short_description":"Update an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"DELETE","short_description":"Destroy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/show","name":"show","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"GET","short_description":"Show an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/copy","name":"copy","apis":[{"api_url":"/katello/api/activation_keys/:id/copy","http_method":"POST","short_description":"Copy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003eName of new activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_host_collections","name":"available_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections/available","http_method":"GET","short_description":"List host collections the activation key does not belong to","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_releases","name":"available_releases","apis":[{"api_url":"/katello/api/activation_keys/:id/releases","http_method":"GET","short_description":"Show release versions available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/product_content","name":"product_content","apis":[{"api_url":"/katello/api/activation_keys/:id/product_content","http_method":"GET","short_description":"Show content available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the activation key\u0026#39;s content\nview version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_host_collections","name":"add_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to associate with activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_host_collections","name":"remove_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to disassociate from the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/add_subscriptions","http_method":"PUT","short_description":"Attach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eQuantity of this subscription to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/remove_subscriptions","http_method":"PUT","short_description":"Unattach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/content_override","name":"content_override","apis":[{"api_url":"/katello/api/activation_keys/:id/content_override","http_method":"PUT","short_description":"Override content for activation_key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters to be added in bulk\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride parameter key or name. Note if name is not provided the default\nname will be \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repositories_bulk_actions":{"doc_url":"../apidoc/v2/repositories_bulk_actions","id":"repositories_bulk_actions","api_url":"/api","name":"Repositories bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories_bulk_actions/destroy_repositories","name":"destroy_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories_bulk_actions/sync_repositories","name":"sync_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/sync","http_method":"POST","short_description":"Synchronize repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ansible_collections":{"doc_url":"../apidoc/v2/ansible_collections","id":"ansible_collections","api_url":"/api","name":"Ansible Collections","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ansible_collections/index","name":"index","apis":[{"api_url":"/katello/api/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_collections/show","name":"show","apis":[{"api_url":"/katello/api/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ansible collection identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_collections/compare","name":"compare","apis":[{"api_url":"/katello/api/ansible_collections/compare","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"repositories":{"doc_url":"../apidoc/v2/repositories","id":"repositories","api_url":"/api","name":"Repositories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories/index","name":"index","apis":[{"api_url":"/katello/api/repositories","http_method":"GET","short_description":"List of enabled repositories","deprecated":null},{"api_url":"/katello/api/content_views/:id/repositories","http_method":"GET","short_description":"List of repositories for a content view","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/repositories","http_method":"GET","short_description":"List of repositories in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id/repositories","http_method":"GET","short_description":"List repositories in the environment","deprecated":null},{"api_url":"/katello/api/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories for a product","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories belonging to a product in an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of an organization to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to show repositories of\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of an environment to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eID of a content view to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eID of a content view version to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_id","full_name":"deb_id","description":"\n\u003cp\u003eId of a deb package to find repositories that contain the deb\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"erratum_id","full_name":"erratum_id","description":"\n\u003cp\u003eId of an erratum to find repositories that contain the erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rpm_id","full_name":"rpm_id","description":"\n\u003cp\u003eId of a rpm package to find repositories that contain the rpm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"file_id","full_name":"file_id","description":"\n\u003cp\u003eId of a file to find repositories that contain the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_id","full_name":"ansible_collection_id","description":"\n\u003cp\u003eId of an ansible collection to find repositories that contain the ansible\ncollection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_branch_id","full_name":"ostree_branch_id","description":"\n\u003cp\u003eId of an ostree branch to find repositories that contain that branch\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"library","full_name":"library","description":"\n\u003cp\u003eshow repositories in Library and the default content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"archived","full_name":"archived","description":"\n\u003cp\u003eshow archived repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003elimit to only repositories of this type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003einterpret specified object to return only Repositories that can be\nassociated with specified object. Only \u0026#39;content_view\u0026#39; \u0026amp;\n\u0026#39;content_view_version\u0026#39; are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"with_content","full_name":"with_content","description":"\n\u003cp\u003eonly repositories having at least one of the specified content type ex: rpm\n, erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003edocker_manifest_list\u003c/code\u003e, \u003ccode\u003edocker_tag\u003c/code\u003e, \u003ccode\u003edocker_blob\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003emodulemd\u003c/code\u003e, \u003ccode\u003eerratum\u003c/code\u003e, \u003ccode\u003edistribution\u003c/code\u003e, \u003ccode\u003epackage_category\u003c/code\u003e, \u003ccode\u003epackage_group\u003c/code\u003e, \u003ccode\u003eyum_repo_metadata_file\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"container_repository_name","type":"string"},{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"distribution_arch","type":"string"},{"name":"distribution_bootable","type":"boolean"},{"name":"distribution_family","type":"string"},{"name":"distribution_variant","type":"string"},{"name":"distribution_version","type":"string"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/create","name":"create","apis":[{"api_url":"/katello/api/repositories","http_method":"POST","short_description":"Create a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the repository\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eProduct the repository belongs to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of repo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39;\nare supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_tags_whitelist","full_name":"docker_tags_whitelist","description":"\n\u003cp\u003eComma separated list of tags to sync for Container Image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either \u0026#39;immediate\u0026#39;,\n\u0026#39;on_demand\u0026#39;, or \u0026#39;background (deprecated)\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e, \u003ccode\u003ebackground\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"download_concurrency","full_name":"download_concurrency","description":"\n\u003cp\u003eUsed to determine download concurrency of the repository in pulp3. Use\nvalue 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":[]},{"name":"mirror_on_sync","full_name":"mirror_on_sync","description":"\n\u003cp\u003etrue if this repository when synced has to be mirrored from the source and\nstale rpms removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are\nsigned by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_policy","full_name":"ostree_upstream_sync_policy","description":"\n\u003cp\u003epolicies for syncing upstream ostree repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elatest\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_depth","full_name":"ostree_upstream_sync_depth","description":"\n\u003cp\u003eif a custom sync policy is chosen for ostree repositories then a\n\u0026#39;depth\u0026#39; value must be provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ecomma separated list of releases to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ecomma separated list of repo components to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ecomma separated list of architectures to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ignore_global_proxy","full_name":"ignore_global_proxy","description":"\n\u003cp\u003eif true, will ignore the globally configured proxy when syncing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/repository_types","name":"repository_types","apis":[{"api_url":"/katello/api/repositories/repository_types","http_method":"GET","short_description":"Show the available repository types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"creatable","full_name":"creatable","description":"\n\u003cp\u003eWhen set to \u0026#39;True\u0026#39; repository types that are creatable will be\nreturned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/republish","name":"republish","apis":[{"api_url":"/katello/api/repositories/:id/republish","http_method":"PUT","short_description":"Forces a republish of the specified repository, regenerating metadata and symlinks on the filesystem.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/show","name":"show","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"GET","short_description":"Show a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/sync","name":"sync","apis":[{"api_url":"/katello/api/repositories/:id/sync","http_method":"POST","short_description":"Sync a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"source_url","full_name":"source_url","description":"\n\u003cp\u003etemporarily override feed URL for sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"incremental","full_name":"incremental","description":"\n\u003cp\u003eperform an incremental import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Only used with yum\nrepositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Only used with yum\nrepositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/export","name":"export","apis":[{"api_url":"/katello/api/repositories/:id/export","http_method":"POST","short_description":"Export a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39;\nare supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_tags_whitelist","full_name":"docker_tags_whitelist","description":"\n\u003cp\u003eComma separated list of tags to sync for Container Image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either \u0026#39;immediate\u0026#39;,\n\u0026#39;on_demand\u0026#39;, or \u0026#39;background (deprecated)\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e, \u003ccode\u003ebackground\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"download_concurrency","full_name":"download_concurrency","description":"\n\u003cp\u003eUsed to determine download concurrency of the repository in pulp3. Use\nvalue 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":[]},{"name":"mirror_on_sync","full_name":"mirror_on_sync","description":"\n\u003cp\u003etrue if this repository when synced has to be mirrored from the source and\nstale rpms removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are\nsigned by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_policy","full_name":"ostree_upstream_sync_policy","description":"\n\u003cp\u003epolicies for syncing upstream ostree repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elatest\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_depth","full_name":"ostree_upstream_sync_depth","description":"\n\u003cp\u003eif a custom sync policy is chosen for ostree repositories then a\n\u0026#39;depth\u0026#39; value must be provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ecomma separated list of releases to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ecomma separated list of repo components to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ecomma separated list of architectures to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ignore_global_proxy","full_name":"ignore_global_proxy","description":"\n\u003cp\u003eif true, will ignore the globally configured proxy when syncing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"DELETE","short_description":"Destroy a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/remove_content","name":"remove_content","apis":[{"api_url":"/katello/api/repositories/:id/remove_packages","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_docker_manifests","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_puppet_modules","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_content","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove content from a repository\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of content ids to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/upload_content","name":"upload_content","apis":[{"api_url":"/katello/api/repositories/:id/upload_content","http_method":"POST","short_description":"Upload content into the repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent files to upload. Can be a single file or array of files.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/import_uploads","name":"import_uploads","apis":[{"api_url":"/katello/api/repositories/:id/import_uploads","http_method":"PUT","short_description":"Import uploads into a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the ImportUpload action to finish. Default: false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"publish_repository","full_name":"publish_repository","description":"\n\u003cp\u003eWhether or not to regenerate the repository on disk. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uploads","full_name":"uploads","description":"\n\u003cp\u003eArray of uploads to import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"uploads[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_unit_id","full_name":"uploads[content_unit_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"uploads[size]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"checksum","full_name":"uploads[checksum]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"uploads[name]","description":"\n\u003cp\u003eNeeds to only be set for file repositories or docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"digest","full_name":"uploads[digest]","description":"\n\u003cp\u003eNeeds to only be set for docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/gpg_key_content","name":"gpg_key_content","apis":[{"api_url":"/katello/api/repositories/:id/gpg_key_content","http_method":"GET","short_description":"Return the content of a repo gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"capsule_content":{"doc_url":"../apidoc/v2/capsule_content","id":"capsule_content","api_url":"/api","name":"Capsule content","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsule_content/lifecycle_environments","name":"lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/available_lifecycle_environments","name":"available_lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/available_lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments not attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/add_lifecycle_environment","name":"add_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"POST","short_description":"Add lifecycle environments to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/remove_lifecycle_environment","name":"remove_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments/:environment_id","http_method":"DELETE","short_description":"Remove lifecycle environments from the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync","name":"sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"POST","short_description":"Synchronize the content to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit the synchronization on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eSkip metadata check on each repository on the smart proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync_status","name":"sync_status","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"GET","short_description":"Get current smart proxy synchronization status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to get the status for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/cancel_sync","name":"cancel_sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"DELETE","short_description":"Cancel running smart proxy synchronization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"capsules":{"doc_url":"../apidoc/v2/capsules","id":"capsules","api_url":"/api","name":"Capsules","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsules/index","name":"index","apis":[{"api_url":"/katello/api/capsules","http_method":"GET","short_description":"List all smart proxies that have content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsules/show","name":"show","apis":[{"api_url":"/katello/api/capsules/:id","http_method":"GET","short_description":"Show the smart proxy details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sync_plans":{"doc_url":"../apidoc/v2/sync_plans","id":"sync_plans","api_url":"/api","name":"Sync plans","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync_plans/index","name":"index","apis":[{"api_url":"/katello/api/sync_plans","http_method":"GET","short_description":"List sync plans","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003efilter by sync date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003efilter by interval\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"enabled","values":["true","false"]},{"name":"interval","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"POST","short_description":"Create a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/add_products","name":"add_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/add_products","http_method":"PUT","short_description":"Add products to sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to add to the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/remove_products","name":"remove_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/remove_products","http_method":"PUT","short_description":"Remove products from sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to remove from the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/sync","name":"sync","apis":[{"api_url":"/katello/api/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_credentials":{"doc_url":"../apidoc/v2/content_credentials","id":"content_credentials","api_url":"/api","name":"Content credentials","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eContent Credentials are used to store credentials like GPG Keys and\nCertificates for the authentication to Products / Repositories.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_credentials/index","name":"index","apis":[{"api_url":"/katello/api/content_credentials","http_method":"GET","short_description":"List content credentials","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the Content Credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/create","name":"create","apis":[{"api_url":"/katello/api/content_credentials","http_method":"POST","short_description":"Create a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the content credential\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/show","name":"show","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"GET","short_description":"Show a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/update","name":"update","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"PUT","short_description":"Update a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the content credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"DELETE","short_description":"Destroy a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/content","name":"content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"GET","short_description":"Return the content of a content credential, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/set_content","name":"set_content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"POST","short_description":"Upload content credential contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003efile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"upstream_subscriptions":{"doc_url":"../apidoc/v2/upstream_subscriptions","id":"upstream_subscriptions","api_url":"/api","name":"Upstream subscriptions","short_description":null,"full_description":"\n\u003cp\u003eRed Hat subscriptions management platform.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/upstream_subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"GET","short_description":"List available subscriptions from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eThe order to sort the results in. [\u0026#39;asc\u0026#39;, \u0026#39;desc\u0026#39;] Defaults\nto \u0026#39;desc\u0026#39;.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eThe field to sort the data by. Defaults to the created date.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eReturn only the upstream pools which map to the given Katello pool IDs\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"quantities_only","full_name":"quantities_only","description":"\n\u003cp\u003eOnly returns id and quantity fields\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"attachable","full_name":"attachable","description":"\n\u003cp\u003eReturn only subscriptions which can be attached to the upstream allocation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"PUT","short_description":"Update the quantity of one or more subscriptions on an upstream allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of Pools to be updated. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eKatello ID of local pool to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eDesired quantity of the pool\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"DELETE","short_description":"Remove one or more subscriptions from an upstream subscription allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eArray of local pool IDs. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"POST","short_description":"Add subscriptions consumed by a manifest from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of pools to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eCandlepin ID of pool to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eQuantity of entitlements to bind\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/ping","name":"ping","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions/ping","http_method":"GET","short_description":"Check if a connection can be made to Red Hat Subscription Management.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/enable_simple_content_access","name":"enable_simple_content_access","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/enable","http_method":"PUT","short_description":"Enable simple content access for a manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/disable_simple_content_access","name":"disable_simple_content_access","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/disable","http_method":"PUT","short_description":"Disable simple content access for a 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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_uploads":{"doc_url":"../apidoc/v2/content_uploads","id":"content_uploads","api_url":"/api","name":"Content uploads","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_uploads/create","name":"create","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads","http_method":"POST","short_description":"Create an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"checksum","full_name":"checksum","description":"\n\u003cp\u003eChecksum of file to upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"PUT","short_description":"Upload a chunk of the file's content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eThe offset in the file where the content starts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eThe actual file contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"DELETE","short_description":"Delete an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"packages":{"doc_url":"../apidoc/v2/packages","id":"packages","api_url":"/api","name":"Packages","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/packages/index","name":"index","apis":[{"api_url":"/katello/api/packages","http_method":"GET","short_description":"List packages","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003ePackage identifiers to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable packages for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_applicable","full_name":"packages_restrict_applicable","description":"\n\u003cp\u003eReturn packages that are applicable to one or more hosts (defaults to true\nif host_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_upgradable","full_name":"packages_restrict_upgradable","description":"\n\u003cp\u003eReturn packages that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_latest","full_name":"packages_restrict_latest","description":"\n\u003cp\u003eReturn only the latest version of each package\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn packages that can be added to the specified object. Only the value\n\u0026#39;content_view_version\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/show","name":"show","apis":[{"api_url":"/katello/api/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/compare","name":"compare","apis":[{"api_url":"/katello/api/packages/compare","http_method":"GET","short_description":"List packages","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_components":{"doc_url":"../apidoc/v2/content_view_components","id":"content_view_components","api_url":"/api","name":"Content view components","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_components/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components","http_method":"GET","short_description":"List components attached to this content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/add_components","name":"add_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/add","http_method":"PUT","short_description":"Add components to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"components","full_name":"components","description":"\n\u003cp\u003eArray of components to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_version_id","full_name":"components[content_view_version_id]","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"components[content_view_id]","description":"\n\u003cp\u003econtent view identifier of the component who\u0026#39;s latest version is\ndesired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"latest","full_name":"components[latest]","description":"\n\u003cp\u003etrue if the latest version of the component\u0026#39;s content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/remove_components","name":"remove_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/remove","http_method":"PUT","short_description":"Remove components from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eArray of content view component IDs to remove. Identifier of the component\nassociation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"GET","short_description":"Show a content view component","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"PUT","short_description":"Update a component associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"latest","full_name":"latest","description":"\n\u003cp\u003etrue if the latest version of the components content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"package_groups":{"doc_url":"../apidoc/v2/package_groups","id":"package_groups","api_url":"/api","name":"Package groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/package_groups/index","name":"index","apis":[{"api_url":"/katello/api/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/show","name":"show","apis":[{"api_url":"/katello/api/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package group identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/compare","name":"compare","apis":[{"api_url":"/katello/api/package_groups/compare","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/create","name":"create","apis":[{"api_url":"/katello/api/package_group","http_method":"POST","short_description":"Create a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003epackage group description. Defaults to \u003ca href=\":name\"\u003eparams\u003c/a\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_visible","full_name":"user_visible","description":"\n\u003cp\u003eset “user_visible” flag on package group. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mandatory_package_names","full_name":"mandatory_package_names","description":"\n\u003cp\u003emandatory package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"optional_package_names","full_name":"optional_package_names","description":"\n\u003cp\u003eoptional package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"conditional_package_names","full_name":"conditional_package_names","description":"\n\u003cp\u003econditional package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default_package_names","full_name":"default_package_names","description":"\n\u003cp\u003edefault package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/destroy","name":"destroy","apis":[{"api_url":"/katello/api/package_group","http_method":"DELETE","short_description":"Delete a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filter_rules":{"doc_url":"../apidoc/v2/content_view_filter_rules","id":"content_view_filter_rules","api_url":"/api","name":"Content view filter rules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filter_rules/index","name":"index","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"GET","short_description":"List filter rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerrata_id of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/create","name":"create","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"POST","short_description":"Create a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [String]","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003epackage group: uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eerratum: IDs or a select all object\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"date_type","full_name":"date_type","description":"\n\u003cp\u003eerratum: search using the \u0026#39;Issued On\u0026#39; or \u0026#39;Updated On\u0026#39;\ncolumn of the errata. Values are \u0026#39;issued\u0026#39;/\u0026#39;updated\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_stream_ids","full_name":"module_stream_ids","description":"\n\u003cp\u003emodule stream ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/show","name":"show","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"GET","short_description":"Show filter rule info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/update","name":"update","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"PUT","short_description":"Update a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag: name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"DELETE","short_description":"Delete a filter rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filters":{"doc_url":"../apidoc/v2/content_view_filters","id":"content_view_filters","api_url":"/api","name":"Content view filters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filters/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"get","short_description":"list filters","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"get","short_description":"list filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter content view filters by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003etypes of filters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_type","values":["rpm","package_group","erratum","docker","modulemd"]},{"name":"inclusion_type","values":["include","exclude"]},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the filter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003etype of filter (e.g. rpm, package_group, erratum, docker, modulemd)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package\nfilter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list.\n(module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default:\ninclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"get","short_description":"show filter info","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"get","short_description":"show filter info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"put","short_description":"update a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"put","short_description":"update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003enew name for the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package\nfilter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list.\n(module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default:\ninclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"sync":{"doc_url":"../apidoc/v2/sync","id":"sync","api_url":"/api","name":"Sync","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/products/:product_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given product","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/sync","http_method":"GET","short_description":"Get status of synchronisation for given repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_histories":{"doc_url":"../apidoc/v2/content_view_histories","id":"content_view_histories","api_url":"/api","name":"Content view histories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_histories/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:id/history","http_method":"GET","short_description":"Show a content view's history","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products_bulk_actions":{"doc_url":"../apidoc/v2/products_bulk_actions","id":"products_bulk_actions","api_url":"/api","name":"Products bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products_bulk_actions/destroy_products","name":"destroy_products","apis":[{"api_url":"/katello/api/products/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/sync_products","name":"sync_products","apis":[{"api_url":"/katello/api/products/bulk/sync","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Non-yum repositories\nare skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Non-yum\nrepositories (or those with \nOn Demand download policy) are skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_http_proxy","name":"update_http_proxy","apis":[{"api_url":"/katello/api/products/bulk/http_proxy","http_method":"PUT","short_description":"Update the HTTP proxy configuration on the repositories of one or more products.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicy for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eHTTP Proxy identifier to associated\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_sync_plans","name":"update_sync_plans","apis":[{"api_url":"/katello/api/products/bulk/sync_plan","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"plan_id","full_name":"plan_id","description":"\n\u003cp\u003eSync plan identifier to attach\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_puppet_modules":{"doc_url":"../apidoc/v2/content_view_puppet_modules","id":"content_view_puppet_modules","api_url":"/api","name":"Content view puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"GET","short_description":"List content view puppet modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003euuid of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"author","type":"string"},{"name":"content_view_name","type":"string"},{"name":"name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"POST","short_description":"Add a puppet module to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ethe id of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"GET","short_description":"Show a content view puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"PUT","short_description":"Update a puppet module associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"DELETE","short_description":"Remove a puppet module from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products":{"doc_url":"../apidoc/v2/products","id":"products","api_url":"/api","name":"Products","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products/index","name":"index","apis":[{"api_url":"/katello/api/products","http_method":"GET","short_description":"List products","deprecated":null},{"api_url":"/katello/api/subscriptions/:subscription_id/products","http_method":"GET","short_description":"List of subscription products in a subscription","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/products","http_method":"GET","short_description":"List of subscription products in an activation key","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/products","http_method":"GET","short_description":"List of products in an organization","deprecated":null},{"api_url":"/katello/api/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter products by organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eFilter products by subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eFilter products by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eReturn enabled products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"custom","full_name":"custom","description":"\n\u003cp\u003eReturn custom products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"redhat_only","full_name":"redhat_only","description":"\n\u003cp\u003eReturn Red Hat (non-custom) products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_available_content","full_name":"include_available_content","description":"\n\u003cp\u003eWhether to include available content attribute in results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003eFilter products by sync plan id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Products that can be associated\nwith specified object. Only \u0026#39;sync_plan\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/create","name":"create","apis":[{"api_url":"/katello/api/products","http_method":"POST","short_description":"Create a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/show","name":"show","apis":[{"api_url":"/katello/api/products/:id","http_method":"GET","short_description":"Show a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/update","name":"update","apis":[{"api_url":"/katello/api/products/:id","http_method":"PUT","short_description":"Updates a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/destroy","name":"destroy","apis":[{"api_url":"/katello/api/products/:id","http_method":"DELETE","short_description":"Destroy a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/sync","name":"sync","apis":[{"api_url":"/katello/api/products/:id/sync","http_method":"POST","short_description":"Sync all repositories for a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_view_versions":{"doc_url":"../apidoc/v2/content_view_versions","id":"content_view_versions","api_url":"/api","name":"Content view versions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_versions/index","name":"index","apis":[{"api_url":"/katello/api/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eFilter versions by environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_module_id","full_name":"puppet_module_id","description":"\n\u003cp\u003eFilter versions by puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eFilter versions by version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"composite_version_id","full_name":"composite_version_id","description":"\n\u003cp\u003eFilter versions that are components in the specified composite version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"triggered_by_id","full_name":"triggered_by_id","description":"\n\u003cp\u003eFilter composite versions whose publish was triggered by the specified\ncomponent version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"repository","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/show","name":"show","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"GET","short_description":"Show content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/promote","name":"promote","apis":[{"api_url":"/katello/api/content_view_versions/:id/promote","http_method":"POST","short_description":"Promote a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"\n\u003cp\u003eforce content view promotion and bypass lifecycle environment restriction\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eIdentifiers for Lifecycle Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version promotion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/update","name":"update","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"PUT","short_description":"Update a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/republish_repositories","name":"republish_repositories","apis":[{"api_url":"/katello/api/content_view_versions/:id/republish_repositories","http_method":"PUT","short_description":"Forces a republish of the version's repositories' metadata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/export_histories","name":"export_histories","apis":[{"api_url":"/katello/api/content_view_versions/export_histories","http_method":"GET","short_description":"Show the export history for a content view version","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":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"content_view_version_id","type":"integer"},{"name":"id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/export","name":"export","apis":[{"api_url":"/katello/api/content_view_versions/:id/export","http_method":"POST","short_description":"Export a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"destination_server","full_name":"destination_server","description":"\n\u003cp\u003eDestination Server name, required for Pulp3\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format. Relevant only for Pulp 2 repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB. Relevant only for Pulp 2 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":[]},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z). Relevant only for\nPulp 2 repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/import","name":"import","apis":[{"api_url":"/katello/api/content_view_versions/import","http_method":"POST","short_description":"Import a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"path","description":"\n\u003cp\u003eImport path\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"DELETE","short_description":"Remove content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/incremental_update","name":"incremental_update","apis":[{"api_url":"/katello/api/content_view_versions/incremental_update","http_method":"POST","short_description":"Perform an Incremental Update on one or more Content View Versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_environments","full_name":"content_view_version_environments","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_version_id","full_name":"content_view_version_environments[content_view_version_id]","description":"\n\u003cp\u003eContent View Version Ids to perform an incremental update on. May contain\ncomposites as well as one or more components to update.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"content_view_version_environments[environment_ids]","description":"\n\u003cp\u003eThe list of environments to promote the specified Content View Version to\n(replacing the older version)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the new generated Content View Versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resolve_dependencies","full_name":"resolve_dependencies","description":"\n\u003cp\u003eIf true, when adding the specified errata or packages, any needed\ndependencies will be copied as well. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"propagate_all_composites","full_name":"propagate_all_composites","description":"\n\u003cp\u003eIf true, will publish a new composite version using any specified\ncontent_view_version_id that has been promoted to a lifecycle environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"add_content","full_name":"add_content","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"errata_ids","full_name":"add_content[errata_ids]","description":"\n\u003cp\u003eErrata ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"package_ids","full_name":"add_content[package_ids]","description":"\n\u003cp\u003ePackage ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"deb_ids","full_name":"add_content[deb_ids]","description":"\n\u003cp\u003eDeb Package ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"puppet_module_ids","full_name":"add_content[puppet_module_ids]","description":"\n\u003cp\u003ePuppet Module ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"update_hosts","full_name":"update_hosts","description":"\n\u003cp\u003eAfter generating the incremental update, apply the changes to the specified\nhosts. Only Errata are supported currently.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"included","full_name":"update_hosts[included]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"update_hosts[included][search]","description":"\n\u003cp\u003eSearch string for host to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"update_hosts[included][ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"update_hosts[excluded]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"update_hosts[excluded][ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_views":{"doc_url":"../apidoc/v2/content_views","id":"content_views","api_url":"/api","name":"Content views","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_views/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"GET","short_description":"List content views","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"GET","short_description":"List content views","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"nondefault","full_name":"nondefault","description":"\n\u003cp\u003eFilter out default content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"noncomposite","full_name":"noncomposite","description":"\n\u003cp\u003eFilter out composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eFilter only composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"without","full_name":"without","description":"\n\u003cp\u003eDo not include this array of content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"composite","type":"boolean"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eContent view label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eComposite content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"PUT","short_description":"Update a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew name for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/publish","name":"publish","apis":[{"api_url":"/katello/api/content_views/:id/publish","http_method":"POST","short_description":"Publish a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the new published content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"major","description":"\n\u003cp\u003eOverride the major version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"minor","description":"\n\u003cp\u003eOverride the minor version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repos_units","full_name":"repos_units","description":"\n\u003cp\u003eSpecify the list of units in each repo\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"label","full_name":"repos_units[label]","description":"\n\u003cp\u003erepo label\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rpm_filenames","full_name":"repos_units[rpm_filenames]","description":"\n\u003cp\u003elist of rpm filename strings to include in published version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"GET","short_description":"Show a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_modules","name":"available_puppet_modules","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_modules","http_method":"GET","short_description":"Get puppet modules that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003emodule name to restrict modules for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_module_names","name":"available_puppet_module_names","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_module_names","http_method":"GET","short_description":"Get puppet modules names that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove_from_environment","name":"remove_from_environment","apis":[{"api_url":"/katello/api/content_views/:id/environments/:environment_id","http_method":"DELETE","short_description":"Remove a content view from an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove","name":"remove","apis":[{"api_url":"/katello/api/content_views/:id/remove","http_method":"PUT","short_description":"Remove versions and/or environments from a content view and reassign systems and keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eenvironment numeric identifiers to be removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view version identifiers to be deleted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"system_content_view_id","full_name":"system_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"system_environment_id","full_name":"system_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"key_content_view_id","full_name":"key_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"key_environment_id","full_name":"key_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"DELETE","short_description":"Delete a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/copy","name":"copy","apis":[{"api_url":"/katello/api/content_views/:id/copy","http_method":"POST","short_description":"Make copy of a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew content view name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"debs":{"doc_url":"../apidoc/v2/debs","id":"debs","api_url":"/api","name":"Deb Packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/debs/index","name":"index","apis":[{"api_url":"/katello/api/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs","http_method":"GET","short_description":"List debs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/debs/show","name":"show","apis":[{"api_url":"/katello/api/debs/:id","http_method":"GET","short_description":"Show a deb","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs/:id","http_method":"GET","short_description":"Show a deb","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea deb identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/debs/compare","name":"compare","apis":[{"api_url":"/katello/api/debs/compare","http_method":"GET","short_description":"List debs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"docker_manifest_lists":{"doc_url":"../apidoc/v2/docker_manifest_lists","id":"docker_manifest_lists","api_url":"/api","name":"Docker manifest lists","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifest_lists/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifest_lists/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest list identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifest_lists/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifest_lists/compare","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_manifests":{"doc_url":"../apidoc/v2/docker_manifests","id":"docker_manifests","api_url":"/api","name":"Docker manifests","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifests/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifests/compare","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_tags":{"doc_url":"../apidoc/v2/docker_tags","id":"docker_tags","api_url":"/api","name":"Docker tags","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_tags/index","name":"index","apis":[{"api_url":"/katello/api/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/show","name":"show","apis":[{"api_url":"/katello/api/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker tag identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_tags/compare","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/repositories","name":"repositories","apis":[{"api_url":"/katello/api/docker_tags/:id/repositories","http_method":"GET","short_description":"List of repositories for a docker meta tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"lifecycle_environments":{"doc_url":"../apidoc/v2/lifecycle_environments","id":"lifecycle_environments","api_url":"/api","name":"Lifecycle environments","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eAn environment is a basic organization structure that groups hosts,\nproducts, repositories, etc. Every host belongs to one environment and\nit\u0026#39;s isolated inside so that it can see only content that is in its\nenvironment.\u003c/p\u003e\n\n\u003cp\u003e## Chains\u003c/p\u003e\n\n\u003cp\u003eEnvironments are ordered into chains and their content (products,\nrepositories, tempaltes, packages) can be moved to an environment only from\nits prior environment. You can have for example chain like:\u003c/p\u003e\n\n\u003cpre\u003eLibrary -\u0026gt; Development -\u0026gt; Testing -\u0026gt; Production\u003c/pre\u003e\n\n\u003cp\u003eEach change in an environment is done through a changeset in an action\ncalled promotion.\u003c/p\u003e\n\n\u003cp\u003e## Library\u003c/p\u003e\n\n\u003cp\u003eLibrary is a special environment that has no ascendant: All the content\nstarts in this environment. More chains can start from the library\nenvironment but no further branching of a chain is enabled.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/lifecycle_environments/index","name":"index","apis":[{"api_url":"/katello/api/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"library","full_name":"library","description":"\n\u003cp\u003eset true if you want to see only library environments\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter only environments containing this name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/show","name":"show","apis":[{"api_url":"/katello/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/create","name":"create","apis":[{"api_url":"/katello/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"POST","short_description":"Create an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"prior_id","full_name":"prior_id","description":"\n\u003cp\u003eID of an environment that is prior to the new environment in the chain. It\nhas to be either the ID of Library or the ID of an environment at the end\nof a chain.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/update","name":"update","apis":[{"api_url":"/katello/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"PUT","short_description":"Update an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003enew name to be given to the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the update action to finish. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/destroy","name":"destroy","apis":[{"api_url":"/katello/api/environments/:id","http_method":"DELETE","short_description":"Destroy an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"DELETE","short_description":"Destroy an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/paths","name":"paths","apis":[{"api_url":"/katello/api/organizations/:organization_id/environments/paths","http_method":"GET","short_description":"List environment paths","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"permission_type","full_name":"permission_type","description":"\n\u003cp\u003eThe associated permission type. One of (readable | promotable) Default:\nreadable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"errata":{"doc_url":"../apidoc/v2/errata","id":"errata","api_url":"/api","name":"Errata","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/errata/index","name":"index","apis":[{"api_url":"/katello/api/errata","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn errata that can be added to the specified object. The values\n\u0026#39;content_view_version\u0026#39; and \u0026#39;content_view_filter are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"bug","type":"string"},{"name":"cve","type":"string"},{"name":"errata_id","type":"string"},{"name":"errata_type","type":"string"},{"name":"id","type":"string"},{"name":"issued","type":"date"},{"name":"modular","values":["true","false"]},{"name":"package","type":"string"},{"name":"package_name","type":"string"},{"name":"reboot_suggested","type":"boolean"},{"name":"repository","type":"string"},{"name":"severity","type":"string"},{"name":"title","type":"string"},{"name":"type","type":"string"},{"name":"updated","type":"date"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/show","name":"show","apis":[{"api_url":"/katello/api/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean erratum identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/compare","name":"compare","apis":[{"api_url":"/katello/api/errata/compare","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/available_errata","name":"available_errata","apis":[{"api_url":"/katello/api/content_view_versions/:id/available_errata","http_method":"GET","short_description":"Return errata that can be added to the Content View Version via an Incremental Update","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"file_units":{"doc_url":"../apidoc/v2/file_units","id":"file_units","api_url":"/api","name":"Files","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/file_units/index","name":"index","apis":[{"api_url":"/katello/api/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/file_units/show","name":"show","apis":[{"api_url":"/katello/api/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea file identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/file_units/compare","name":"compare","apis":[{"api_url":"/katello/api/files/compare","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"gpg_keys":{"doc_url":"../apidoc/v2/gpg_keys","id":"gpg_keys","api_url":"/api","name":"Gpg keys","short_description":null,"full_description":"\n\u003cp\u003e# Description Documents the calls for the list, read, create, update and\ndelete operations for GPG keys\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/gpg_keys/index","name":"index","apis":[{"api_url":"/katello/api/gpg_keys","http_method":"GET","short_description":"List gpg keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/create","name":"create","apis":[{"api_url":"/katello/api/gpg_keys","http_method":"POST","short_description":"Create a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the gpg key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/show","name":"show","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"GET","short_description":"Show a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/update","name":"update","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the gpg key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"DELETE","short_description":"Destroy a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/content","name":"content","apis":[{"api_url":"/katello/api/gpg_keys/:id/content","http_method":"GET","short_description":"Return the content of a gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/set_content","name":"set_content","apis":[{"api_url":"/katello/api/gpg_keys/:id/content","http_method":"POST","short_description":"Upload gpg key contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003efile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_collections":{"doc_url":"../apidoc/v2/host_collections","id":"host_collections","api_url":"/api","name":"Host collections","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_collections/show","name":"show","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"GET","short_description":"Show a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/index","name":"index","apis":[{"api_url":"/katello/api/host_collections","http_method":"GET","short_description":"List host collections","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"GET","short_description":"List host collections within an organization","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/host_collections","http_method":"GET","short_description":"List host collections in an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eactivation key identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eFilter products by host id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Host Collections that can be\nassociated with specified object. The value \u0026#39;host\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"host","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/create","name":"create","apis":[{"api_url":"/katello/api/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/update","name":"update","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"PUT","short_description":"Update a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/add_hosts","name":"add_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/add_hosts","http_method":"PUT","short_description":"Add host to the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/remove_hosts","name":"remove_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/remove_hosts","http_method":"PUT","short_description":"Remove hosts from the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/destroy","name":"destroy","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"DELETE","short_description":"Destroy a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/copy","name":"copy","apis":[{"api_url":"/katello/api/host_collections/:id/copy","http_method":"POST","short_description":"Make copy of a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew host collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_debs":{"doc_url":"../apidoc/v2/host_debs","id":"host_debs","api_url":"/api","name":"Host debs","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_debs/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/debs","http_method":"GET","short_description":"List deb packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_errata":{"doc_url":"../apidoc/v2/host_errata","id":"host_errata","api_url":"/api","name":"Host errata","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_errata/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/errata","http_method":"GET","short_description":"List errata available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Content View\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/apply","name":"apply","apis":[{"api_url":"/api/hosts/:host_id/errata/apply","http_method":"PUT","short_description":"Schedule errata for installation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids to install\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"\n\u003cp\u003eErrata to exclusively include in the action\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for erratum to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of errata ids to perform an action on, (ex: RHSA-2019:1168)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"\n\u003cp\u003eErrata to explicitly exclude in the action. All other applicable errata\nwill be included in the action, unless an included parameter is passed as\nwell.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of errata ids to exclude and not run an action on, (ex:\nRHSA-2019:1168)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/errata/:id","http_method":"GET","short_description":"Retrieve a single errata for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eErrata id of the erratum (RHSA-2012:108)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/applicability","name":"applicability","apis":[{"api_url":"/api/hosts/:host_id/errata/applicability","http_method":"PUT","short_description":"Force regenerate applicability.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_module_streams":{"doc_url":"../apidoc/v2/host_module_streams","id":"host_module_streams","api_url":"/api","name":"Host module streams","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_module_streams/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/module_streams","http_method":"GET","short_description":"List module streams available to the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eStreams based on the host based on their status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eenabled\u003c/code\u003e, \u003ccode\u003edisabled\u003c/code\u003e, \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003einstalled\u003c/code\u003e, \u003ccode\u003eupgradable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_packages":{"doc_url":"../apidoc/v2/host_packages","id":"host_packages","api_url":"/api","name":"Host packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_packages/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/packages","http_method":"GET","short_description":"List packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"arch","type":"string"},{"name":"epoch","type":"string"},{"name":"name","type":"string"},{"name":"nvra","type":"string"},{"name":"nvrea","type":"string"},{"name":"release","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/install","name":"install","apis":[{"api_url":"/api/hosts/:host_id/packages/install","http_method":"PUT","short_description":"Install packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade","name":"upgrade","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003elist of packages names\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade_all","name":"upgrade_all","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade_all","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/remove","name":"remove","apis":[{"api_url":"/api/hosts/:host_id/packages/remove","http_method":"PUT","short_description":"Uninstall packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_tracer":{"doc_url":"../apidoc/v2/host_tracer","id":"host_tracer","api_url":"/api","name":"Host tracer","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_tracer/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/traces","http_method":"GET","short_description":"List services that need restarting on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_tracer/resolve","name":"resolve","apis":[{"api_url":"/api/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":[]},{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"hosts_bulk_actions":{"doc_url":"../apidoc/v2/hosts_bulk_actions","id":"hosts_bulk_actions","api_url":"/api","name":"Hosts bulk actions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_add_host_collections","name":"bulk_add_host_collections","apis":[{"api_url":"/api/hosts/bulk/add_host_collections","http_method":"PUT","short_description":"Add one or more host collections to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_remove_host_collections","name":"bulk_remove_host_collections","apis":[{"api_url":"/api/hosts/bulk/remove_host_collections","http_method":"PUT","short_description":"Remove one or more host collections from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/applicable_errata","name":"applicable_errata","apis":[{"api_url":"/api/hosts/bulk/applicable_errata","http_method":"POST","short_description":"Fetch applicable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/installable_errata","name":"installable_errata","apis":[{"api_url":"/api/hosts/bulk/installable_errata","http_method":"POST","short_description":"Fetch installable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/install_content","name":"install_content","apis":[{"api_url":"/api/hosts/bulk/install_content","http_method":"PUT","short_description":"Install content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;,\n\u0026#39;package_group\u0026#39; and \u0026#39;errata\u0026#39;.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package names, package group names or errata ids)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/update_content","name":"update_content","apis":[{"api_url":"/api/hosts/bulk/update_content","http_method":"PUT","short_description":"Update content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;\nand \u0026#39;package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"update_all","full_name":"update_all","description":"\n\u003cp\u003eUpdates all packages on the host(s)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_content","name":"remove_content","apis":[{"api_url":"/api/hosts/bulk/remove_content","http_method":"PUT","short_description":"Remove content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;\nand \u0026#39;package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/destroy_hosts","name":"destroy_hosts","apis":[{"api_url":"/api/hosts/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/bulk/remove_subscriptions","http_method":"PUT","short_description":"Remove subscriptions from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of specified subscription to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/bulk/add_subscriptions","http_method":"PUT","short_description":"Add subscriptions to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/bulk/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/content_overrides","name":"content_overrides","apis":[{"api_url":"/api/hosts/bulk/content_overrides","http_method":"PUT","short_description":"Set content overrides to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be\n\u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/environment_content_view","name":"environment_content_view","apis":[{"api_url":"/api/hosts/bulk/environment_content_view","http_method":"PUT","short_description":"Assign the environment and content view to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/release_version","name":"release_version","apis":[{"api_url":"/api/hosts/bulk/release_version","http_method":"PUT","short_description":"Assign the release version to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/traces","name":"traces","apis":[{"api_url":"/api/hosts/bulk/traces","http_method":"POST","short_description":"Fetch traces for one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/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":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/available_incremental_updates","name":"available_incremental_updates","apis":[{"api_url":"/api/hosts/bulk/available_incremental_updates","http_method":"POST","short_description":"Given a set of hosts and errata, lists the content view versions and environments that need updating.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/module_streams","name":"module_streams","apis":[{"api_url":"/api/hosts/bulk/module_streams","http_method":"POST","short_description":"Fetch available module streams for hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"module_streams":{"doc_url":"../apidoc/v2/module_streams","id":"module_streams","api_url":"/api","name":"Module streams","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/module_streams/index","name":"index","apis":[{"api_url":"/katello/api/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host id to list available module streams for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"name_stream_only","full_name":"name_stream_only","description":"\n\u003cp\u003eReturn name and stream information only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/module_streams/show","name":"show","apis":[{"api_url":"/katello/api/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea module stream identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/module_streams/compare","name":"compare","apis":[{"api_url":"/katello/api/module_streams/compare","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ostree_branches":{"doc_url":"../apidoc/v2/ostree_branches","id":"ostree_branches","api_url":"/api","name":"Ostree branches","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ostree_branches/index","name":"index","apis":[{"api_url":"/katello/api/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ostree_branches/show","name":"show","apis":[{"api_url":"/katello/api/ostree_branches/:id","http_method":"GET","short_description":"Show an ostree branch","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_branches/:id","http_method":"GET","short_description":"Show an ostree branch","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ostree branch identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ostree_branches/compare","name":"compare","apis":[{"api_url":"/katello/api/ostree_branches/compare","http_method":"GET","short_description":"List ostree_branches","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repository_sets":{"doc_url":"../apidoc/v2/repository_sets","id":"repository_sets","api_url":"/api","name":"Repository sets","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repository_sets/index","name":"index","apis":[{"api_url":"/katello/api/repository_sets","http_method":"GET","short_description":"List repository sets.","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets","http_method":"GET","short_description":"List repository sets for a product.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eRepository set name to search on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eIf true, only return repository sets that have been enabled. Defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"with_active_subscription","full_name":"with_active_subscription","description":"\n\u003cp\u003eIf true, only return repository sets that are associated with an active\nsubscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"with_custom","full_name":"with_custom","description":"\n\u003cp\u003eIf true, return custom repository sets along with redhat repos\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/show","name":"show","apis":[{"api_url":"/katello/api/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/available_repositories","name":"available_repositories","apis":[{"api_url":"/katello/api/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/enable","name":"enable","apis":[{"api_url":"/katello/api/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to enable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/disable","name":"disable","apis":[{"api_url":"/katello/api/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to disable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"srpms":{"doc_url":"../apidoc/v2/srpms","id":"srpms","api_url":"/api","name":"Srpms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/srpms/index","name":"index","apis":[{"api_url":"/katello/api/srpms","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/srpms/show","name":"show","apis":[{"api_url":"/katello/api/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSRPM details identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/srpms/compare","name":"compare","apis":[{"api_url":"/katello/api/srpms/compare","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subscriptions":{"doc_url":"../apidoc/v2/subscriptions","id":"subscriptions","api_url":"/api","name":"Subscriptions","short_description":null,"full_description":"\n\u003cp\u003eSubscriptions management.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions","http_method":"GET","short_description":"List organization subscriptions","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/subscriptions","http_method":"GET","short_description":"List an activation key's subscriptions","deprecated":null},{"api_url":"/katello/api/subscriptions","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of a host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eActivation key ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eObject to show subscriptions available for, either \u0026#39;host\u0026#39; or\n\u0026#39;activation_key\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"match_host","full_name":"match_host","description":"\n\u003cp\u003eIgnore subscriptions that are unavailable to the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"match_installed","full_name":"match_installed","description":"\n\u003cp\u003eReturn subscriptions that match installed products of the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"no_overlap","full_name":"no_overlap","description":"\n\u003cp\u003eReturn subscriptions which do not overlap with a currently-attached\nsubscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null},{"api_url":"/katello/api/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/upload","name":"upload","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eSubscription manifest file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]},{"name":"repository_url","full_name":"repository_url","description":"\n\u003cp\u003erepository url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/refresh_manifest","name":"refresh_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/refresh_manifest","http_method":"PUT","short_description":"Refresh previously imported manifest for Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/delete_manifest","name":"delete_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/delete_manifest","http_method":"POST","short_description":"Delete manifest from Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/manifest_history","name":"manifest_history","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/manifest_history","http_method":"GET","short_description":"obtain manifest history for subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}},"link_extension":".html"}} \ No newline at end of file +{"docs":{"name":"Foreman","info":"\n\u003cp\u003eForeman API v2 is currently the default API version.\u003c/p\u003e\n","copyright":"","doc_url":"../apidoc/v2","api_url":"/api","resources":{"host_subscriptions":{"doc_url":"../apidoc/v2/host_subscriptions","id":"host_subscriptions","api_url":"/api","name":"Host subscriptions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_subscriptions/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"GET","short_description":"List a host's subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"DELETE","short_description":"Unregister the host as a subscription consumer","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/create","name":"create","apis":[{"api_url":"/api/hosts/subscriptions","http_method":"POST","short_description":"Register a host with subscription and information","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eUUID to use for registered host, random uuid is generated if not provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003eKey-value hash of subscription-manager facts, nesting uses a period\ndelimiter (.)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"hypervisor_guest_uuids","description":"\n\u003cp\u003eUUIDs of the virtual guests from the host\u0026#39;s hypervisor\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products","full_name":"installed_products","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"installed_products[product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"installed_products[product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"installed_products[arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"installed_products[version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003eRelease version of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eA service level for auto-healing process, e.g. SELF-SUPPORT\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"lifecycle_environment_id","description":"\n\u003cp\u003eLifecycle Environment ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent View ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/remove_subscriptions","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eIf specified, remove the first instance of a subscription with matching id\nand quantity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/add_subscriptions","http_method":"PUT","short_description":"Add a subscription to a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/content_override","name":"content_override","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/content_override","http_method":"PUT","short_description":"Set content overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n\u003cp\u003eOverride to a boolean value or \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be\n\u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/product_content","name":"product_content","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/product_content","http_method":"GET","short_description":"Get content and overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the host\u0026#39;s content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/available_release_versions","name":"available_release_versions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/available_release_versions","http_method":"GET","short_description":"Show releases available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"interfaces":{"doc_url":"../apidoc/v2/interfaces","id":"interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"GET","short_description":"Show an interface for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subnets":{"doc_url":"../apidoc/v2/subnets","id":"subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/create","name":"create","apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"registration":{"doc_url":"../apidoc/v2/registration","id":"registration","api_url":"/api","name":"Registration","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/registration/global","name":"global","apis":[{"api_url":"/api/register","http_method":"GET","short_description":"Render Global registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the Organization to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of the Location to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of the Host group to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of the Operating System to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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\nset to true, insights client will be installed and registered on Red Hat\nfamily 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":[]},{"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\nit 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":[]},{"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":[]}],"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 registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"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":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]},{"name":"setup_insights","full_name":"setup_insights","description":"\n\u003cp\u003eSet \u0026#39;host_registration_insights\u0026#39; parameter for the host. If it is\nset to true, insights client will be installed and registered on Red Hat\nfamily 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":[]},{"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\nit 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":[]},{"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":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null},{"api_url":"/api/environments/:environment_id/hosts","http_method":"GET","short_description":"List hosts per environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"activation_key","type":"string"},{"name":"activation_key_id","type":"string"},{"name":"addon","type":"string"},{"name":"addons_status","values":["mismatched","matched","not_specified"]},{"name":"applicable_errata","type":"string"},{"name":"applicable_errata_issued","type":"date"},{"name":"applicable_rpms","type":"string"},{"name":"architecture","type":"string"},{"name":"autoheal","type":"boolean"},{"name":"available_module_stream_name","type":"string"},{"name":"available_module_stream_stream","type":"string"},{"name":"boot_time","type":""},{"name":"build","values":["true","false"]},{"name":"class","type":"string"},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"config_group","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"created_at","type":"datetime"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"environment","type":"string"},{"name":"errata_status","values":["security_needed","errata_needed","updated","unknown"]},{"name":"execution_status","values":["ok","error"]},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","type":"string"},{"name":"has_mac","type":"string"},{"name":"host_collection","type":"string"},{"name":"host_collection_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_id","type":"integer"},{"name":"hostgroup_name","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"hypervisor","type":"boolean"},{"name":"hypervisor_host","type":"string"},{"name":"id","type":"integer"},{"name":"image","type":"string"},{"name":"installable_errata","type":"string"},{"name":"installed_at","type":"datetime"},{"name":"installed_package","type":"string"},{"name":"installed_package_name","type":"string"},{"name":"ip","type":"string"},{"name":"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_environment","type":"string"},{"name":"lifecycle_environment_id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mac","type":"string"},{"name":"managed","values":["true","false"]},{"name":"model","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"owner","type":"string"},{"name":"owner_id","type":"integer"},{"name":"owner_type","type":"string"},{"name":"params","type":"string"},{"name":"params_name","type":"string"},{"name":"parent_hostgroup","type":"string"},{"name":"pools_expiring_in_days","type":"string"},{"name":"puppet_ca","type":"string"},{"name":"puppet_proxy_id","type":"integer"},{"name":"puppetmaster","type":"string"},{"name":"purpose_status","values":["mismatched","matched","not_specified"]},{"name":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"name":"registered_at","type":"datetime"},{"name":"registered_through","type":"string"},{"name":"release_version","type":"string"},{"name":"role","type":"text"},{"name":"role_status","values":["mismatched","matched","not_specified"]},{"name":"service_level","type":"string"},{"name":"sla_status","values":["mismatched","matched","not_specified"]},{"name":"smart_proxy","type":"string"},{"name":"status.applied","type":"integer"},{"name":"status.enabled","values":["true","false"]},{"name":"status.failed","type":"integer"},{"name":"status.failed_restarts","type":"integer"},{"name":"status.interesting","values":["true","false"]},{"name":"status.pending","type":"integer"},{"name":"status.restarted","type":"integer"},{"name":"status.skipped","type":"integer"},{"name":"subnet","type":"string"},{"name":"subnet.name","type":"text"},{"name":"subnet6","type":"string"},{"name":"subnet6.name","type":"text"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"subscription_status","values":["valid","partial","invalid","unknown","disabled","unsubscribed_hypervisor"]},{"name":"subscription_uuid","type":"string"},{"name":"trace_app","type":"string"},{"name":"trace_app_type","type":"string"},{"name":"trace_helper","type":"string"},{"name":"trace_status","values":["reboot_needed","process_restart_needed","updated"]},{"name":"upgradable_rpms","type":"string"},{"name":"usage","type":"text"},{"name":"usage_status","values":["mismatched","matched","not_specified"]},{"name":"user.firstname","type":"string"},{"name":"user.lastname","type":"string"},{"name":"user.login","type":"string"},{"name":"user.mail","type":"string"},{"name":"usergroup","type":"string"},{"name":"usergroup.name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/show","name":"show","apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"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":[]},{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"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":[]},{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/enc","name":"enc","apis":[{"api_url":"/api/hosts/:id/enc","http_method":"GET","short_description":"Get ENC values of host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eglobal\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003econfiguration\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ebuild\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host\u0026#39;s compute attributes that can be used to create a clone\nof this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot),\n(cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host,\nContent_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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE,\nprovision, finish, script, user_data, ZTP, POAP, cloud-init, registration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/host_collections","name":"host_collections","apis":[{"api_url":"/api/hosts/:host_id/host_collections","http_method":"PUT","short_description":"Alter a hosts host collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eThe id of the host to alter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","id":"hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/hostgroups","http_method":"GET","short_description":"List all host groups for a Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"class","type":"string"},{"name":"config_group","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/create","name":"create","apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/update","name":"update","apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/clone","name":"clone","apis":[{"api_url":"/api/hostgroups/:id/clone","http_method":"POST","short_description":"Clone a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host,\nContent_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":[]},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","id":"smart_proxies","api_url":"/api","name":"Smart proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/create","name":"create","apis":[{"api_url":"/api/smart_proxies","http_method":"POST","short_description":"Create a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/update","name":"update","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"PUT","short_description":"Update a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"DELETE","short_description":"Delete a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","id":"template_combinations","api_url":"/api","name":"Template combinations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"GET","short_description":"DEPRECATED: List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment - DEPRECATED will have no effect\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"POST","short_description":"DEPRECATED: Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment - DEPRECATED will have no effect\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"GET","short_description":"DEPRECATED: Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment - DEPRECATED will have no effect\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"PUT","short_description":"DEPRECATED: Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment - DEPRECATED will have no effect\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"architectures":{"doc_url":"../apidoc/v2/architectures","id":"architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"../apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template inputs","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"POST","short_description":"Create a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is Fact value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is Variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is Puppet parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is Puppet parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::GpgKey\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"PUT","short_description":"Update a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is Fact value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is Variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is Puppet parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is Puppet parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::GpgKey\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"../apidoc/v2/audits","id":"audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"action","type":"string"},{"name":"auditable_id","type":"integer"},{"name":"changes","type":"text"},{"name":"comment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"interface_fqdn","type":"string"},{"name":"interface_ip","type":"string"},{"name":"interface_mac","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_title","type":"string"},{"name":"parameter","type":"string"},{"name":"partition_table","type":"string"},{"name":"provisioning_template","type":"string"},{"name":"puppetclass","type":"string"},{"name":"remote_address","type":"string"},{"name":"request_uuid","type":"string"},{"name":"setting","type":"string"},{"name":"time","type":"datetime"},{"name":"type","values":["role","ptable","provisioning_template","user","filter","architecture","bookmark","compute_profile","config_group","domain","environment","host_class","hostgroup","http_proxy","image","key_pair","medium","model","personal_access_token","report_template","puppetclass","realm","smart_proxy","ssh_key","subnet","usergroup","job_template","job_invocation","remote_execution_feature","katello/repository","katello/host/content_facet","katello/hostgroup/content_facet","katello/host/subscription_facet","katello/activation_key","katello/content_view","katello/gpg_key","katello/host_collection","katello/kt_environment","katello/product","katello/sync_plan","lookup_value","hostgroup_class","auth_source","compute_resource","host","interface","location","organization","os","override_value","parameter","partition_table","setting","smart_class_parameter"]},{"name":"user","type":"string"},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"../apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal access tokens","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"../apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth source externals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/update","name":"update","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"PUT","short_description":"Update an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ping":{"doc_url":"../apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/index","name":"index","apis":[{"api_url":"/katello/api/ping","http_method":"GET","short_description":"Shows status of Katello system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/server_status","name":"server_status","apis":[{"api_url":"/katello/api/status","http_method":"GET","short_description":"Shows version information","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"auth_source_internals":{"doc_url":"../apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth source internals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"plugins":{"doc_url":"../apidoc/v2/plugins","id":"plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","id":"auth_source_ldaps","api_url":"/api","name":"Auth source ldaps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/create","name":"create","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"POST","short_description":"Create an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","id":"template_kinds","api_url":"/api","name":"Template kinds","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_sources":{"doc_url":"../apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth sources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"trends":{"doc_url":"../apidoc/v2/trends","id":"trends","api_url":"/api","name":"Trends","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API enpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/trends/index","name":"index","apis":[{"api_url":"/api/trends","http_method":"GET","short_description":"List of trends counters","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/show","name":"show","apis":[{"api_url":"/api/trends/:id","http_method":"GET","short_description":"Show a trend","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/create","name":"create","apis":[{"api_url":"/api/trends","http_method":"POST","short_description":"Create a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/destroy","name":"destroy","apis":[{"api_url":"/api/trends/:id","http_method":"DELETE","short_description":"Delete a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"autosign":{"doc_url":"../apidoc/v2/autosign","id":"autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","id":"usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the Foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","id":"bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/create","name":"create","apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"environment","type":"string"},{"name":"hostgroup","type":"string"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/create","name":"create","apis":[{"api_url":"/api/provisioning_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/build_pxe_default","name":"build_pxe_default","apis":[{"api_url":"/api/provisioning_templates/build_pxe_default","http_method":"POST","short_description":"Update the default PXE menu on all configured TFTP servers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","id":"common_parameters","api_url":"/api","name":"Common parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/create","name":"create","apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"../apidoc/v2/ptables","id":"ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/create","name":"create","apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","id":"compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","id":"puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"key","type":"string"},{"name":"location","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","id":"compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/create","name":"create","apis":[{"api_url":"/api/compute_profiles","http_method":"POST","short_description":"Create a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_hosts":{"doc_url":"../apidoc/v2/puppet_hosts","id":"puppet_hosts","api_url":"/api","name":"Puppet hosts","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Remote Execution Plugin.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nRemote Execution Plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","id":"compute_resources","api_url":"/api","name":"Compute resources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show","name":"show","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/create","name":"create","apis":[{"api_url":"/api/compute_resources","http_method":"POST","short_description":"Create a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_images","name":"available_images","apis":[{"api_url":"/api/compute_resources/:id/available_images","http_method":"GET","short_description":"List available images for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_clusters","name":"available_clusters","apis":[{"api_url":"/api/compute_resources/:id/available_clusters","http_method":"GET","short_description":"List available clusters for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_flavors","name":"available_flavors","apis":[{"api_url":"/api/compute_resources/:id/available_flavors","http_method":"GET","short_description":"List available flavors for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_folders","name":"available_folders","apis":[{"api_url":"/api/compute_resources/:id/available_folders","http_method":"GET","short_description":"List available folders for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_zones","name":"available_zones","apis":[{"api_url":"/api/compute_resources/:id/available_zones","http_method":"GET","short_description":"List available zone for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_networks","name":"available_networks","apis":[{"api_url":"/api/compute_resources/:id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/refresh_cache","name":"refresh_cache","apis":[{"api_url":"/api/compute_resources/:id/refresh_cache","http_method":"PUT","short_description":"Refresh Compute Resource Cache","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_virtual_machines","name":"available_virtual_machines","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines","http_method":"GET","short_description":"List available virtual machines for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show_vm","name":"show_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"GET","short_description":"Show a virtual machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/power_vm","name":"power_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id/power","http_method":"PUT","short_description":"Power a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy_vm","name":"destroy_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"DELETE","short_description":"Delete a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"../apidoc/v2/users","id":"users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"last_login_on","type":"datetime"},{"name":"lastname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"login","type":"string"},{"name":"mail","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"usergroup","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user if it is not already present.\nOnly another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_groups":{"doc_url":"../apidoc/v2/config_groups","id":"config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"class","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"../apidoc/v2/realms","id":"realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/create","name":"create","apis":[{"api_url":"/api/realms","http_method":"POST","short_description":"Create a realm","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003ename\u003c/strong\u003e field is used for the name of the realm.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"environment","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/create","name":"create","apis":[{"api_url":"/api/config_reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","id":"dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"../apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are of the form\n\u003cem\u003ehostname\u003c/em\u003e.\u003cstrong\u003esomewhere.com\u003c/strong\u003e then the domain is\n\u003cstrong\u003esomewhere.com\u003c/strong\u003e. This allows Foreman to associate a puppet\nvariable with a domain/site and automatically append this variable to all\nexternal node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003efullname\u003c/strong\u003e field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"environments":{"doc_url":"../apidoc/v2/environments","id":"environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/environments","http_method":"GET","short_description":"List environments of Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/environments","http_method":"GET","short_description":"List environments per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","id":"external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","id":"fact_values","api_url":"/api","name":"Fact values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/create","name":"create","apis":[{"api_url":"/api/filters","http_method":"POST","short_description":"Create a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"../apidoc/v2/home","id":"home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_classes":{"doc_url":"../apidoc/v2/host_classes","id":"host_classes","api_url":"/api","name":"Host classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_classes/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"../apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/create","name":"create","apis":[{"api_url":"/api/report_templates","http_method":"POST","short_description":"Create a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/generate","name":"generate","apis":[{"api_url":"/api/report_templates/:id/generate","http_method":"POST","short_description":"Generate report from a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action\nreturns an url to get resulting report from (see\n\u003cstrong\u003ereport_data\u003c/strong\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use \u0026#39;,\u0026#39; to\nseparate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API\nendpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is\ndelivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn\u0026#39;t\nbeen generated yet, it will return an empty response with http status 204 -\nNoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroup_classes":{"doc_url":"../apidoc/v2/hostgroup_classes","id":"hostgroup_classes","api_url":"/api","name":"Hostgroup classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroup_classes/index","name":"index","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/create","name":"create","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"../apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/create","name":"create","apis":[{"api_url":"/api/http_proxies","http_method":"POST","short_description":"Create an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"../apidoc/v2/images","id":"images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"../apidoc/v2/locations","id":"locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/show","name":"show","apis":[{"api_url":"/api/locations/:id","http_method":"GET","short_description":"Show a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/create","name":"create","apis":[{"api_url":"/api/locations","http_method":"POST","short_description":"Create a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"../apidoc/v2/roles","id":"roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/create","name":"create","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"POST","short_description":"Add an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"../apidoc/v2/media","id":"media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/create","name":"create","apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"../apidoc/v2/models","id":"models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/create","name":"create","apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"../apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","id":"operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"../apidoc/v2/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/katello/api/organizations","http_method":"GET","short_description":"List all organizations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"GET","short_description":"Show organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/katello/api/organizations","http_method":"POST","short_description":"Create organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"PUT","short_description":"Update organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"redhat_repository_url","full_name":"redhat_repository_url","description":"\n\u003cp\u003eRed Hat CDN URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/repo_discover","name":"repo_discover","apis":[{"api_url":"/katello/api/organizations/:id/repo_discover","http_method":"PUT","short_description":"Discover Repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003eBase URL to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eOne of yum or docker\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch pattern (defaults to \u0026#39;*\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/cancel_repo_discover","name":"cancel_repo_discover","apis":[{"api_url":"/katello/api/organizations/:label/cancel_repo_discover","http_method":"PUT","short_description":"Cancel repository discovery","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003ebase url to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/download_debug_certificate","name":"download_debug_certificate","apis":[{"api_url":"/katello/api/organizations/:label/download_debug_certificate","http_method":"GET","short_description":"Download a debug certificate","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/releases","name":"releases","apis":[{"api_url":"/katello/api/organizations/:id/releases","http_method":"GET","short_description":"List available releases in the organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the Organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/redhat_provider","name":"redhat_provider","apis":[{"api_url":"/katello/api/organizations/:id/redhat_provider","http_method":"GET","short_description":"List all :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"settings":{"doc_url":"../apidoc/v2/settings","id":"settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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}],"additional_properties":false}],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"Information about the setting","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eOBSOLATED: id of the setting record, doesn\u0026#39;t need to be set in the\nfuture\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"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},{"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},{"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},{"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},{"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},{"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},{"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},{"name":"value","full_name":"value","description":"\n\u003cp\u003eSetting current value. If this setting is encypted, the value will not be\nreturned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"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.","expected_type":"string","metadata":null,"show":true},{"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.","expected_type":"string","metadata":null,"show":true},{"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},{"name":"select_values","full_name":"select_values","description":"\n\u003cp\u003eIf this setting has list of possible values, this includes the list of the\nvalues.\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},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003eDEPRECATED: this will be always application install time and dropped in the\nfuture release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Time","expected_type":"string","metadata":null,"show":true},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003eLast updated. NOTE: this will be reset to application install time, when\nsetting 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}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[{"code":200,"description":"Information about the updated setting","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eOBSOLATED: id of the setting record, doesn\u0026#39;t need to be set in the\nfuture\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true},{"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},{"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},{"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},{"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},{"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},{"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},{"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},{"name":"value","full_name":"value","description":"\n\u003cp\u003eSetting current value. If this setting is encypted, the value will not be\nreturned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"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.","expected_type":"string","metadata":null,"show":true},{"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.","expected_type":"string","metadata":null,"show":true},{"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},{"name":"select_values","full_name":"select_values","description":"\n\u003cp\u003eIf this setting has list of possible values, this includes the list of the\nvalues.\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},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003eDEPRECATED: this will be always application install time and dropped in the\nfuture release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Time","expected_type":"string","metadata":null,"show":true},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003eLast updated. NOTE: this will be reset to application install time, when\nsetting 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}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","id":"os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"GET","short_description":"Show a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"tasks":{"doc_url":"../apidoc/v2/tasks","id":"tasks","api_url":"/api","name":"Tasks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"override_values":{"doc_url":"../apidoc/v2/override_values","id":"override_values","api_url":"/api","name":"Override values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/override_values/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"../apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cstrong\u003enested parameters for a host,\ndomain, subnet, host group, operating system\u003c/strong\u003e. If you are looking\nfor \u0026lt;a href=“common_parameters.html”\u0026gt;global parameters\u0026lt;/a\u0026gt;, go\nto \u0026lt;a href=“common_parameters.html”\u0026gt;this link\u0026lt;/a\u0026gt;.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"../apidoc/v2/permissions","id":"permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/resource_types","name":"resource_types","apis":[{"api_url":"/api/permissions/resource_types","http_method":"GET","short_description":"List available resource types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_class_parameters":{"doc_url":"../apidoc/v2/smart_class_parameters","id":"smart_class_parameters","api_url":"/api","name":"Smart class parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_class_parameters/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters","http_method":"GET","short_description":"List all smart class parameters","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment/Puppet class combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"avoid_duplicates","values":["true","false"]},{"name":"environment","type":"string"},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"},{"name":"puppetclass","type":"string"},{"name":"puppetclass_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"GET","short_description":"Show a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"PUT","short_description":"Update a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"\n\u003cp\u003eWhether the smart class parameter value is managed by Foreman\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003cp\u003eDescription of smart class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"\n\u003cp\u003eValue to use when there is no match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"smart_class_parameter[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"smart_class_parameter[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output. Puppet will\nuse the value defined in the Puppet manifest for this parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"smart_class_parameter[path]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"smart_class_parameter[required]","description":"\n\u003cp\u003eIf true, will raise an error if there is no default value and no matcher\nprovide a value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"smart_class_parameter[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"smart_class_parameter[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"smart_class_parameter[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"../apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"statistics":{"doc_url":"../apidoc/v2/statistics","id":"statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API endpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install the\nForeman Statistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"recurring_logics":{"doc_url":"../apidoc/v2/recurring_logics","id":"recurring_logics","api_url":"/api","name":"Recurring logics","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/recurring_logics/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/recurring_logics","http_method":"GET","short_description":"List recurring logics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"GET","short_description":"Show recurring logic details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/update","name":"update","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"PUT","short_description":"Update recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eWhether the recurring logic is enabled or disabled.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/cancel","name":"cancel","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id/cancel","http_method":"POST","short_description":"Cancel recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/bulk_destroy","name":"bulk_destroy","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/bulk_destroy","http_method":"POST","short_description":"Delete recurring logics by search query","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch query\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreman_tasks":{"doc_url":"../apidoc/v2/foreman_tasks","id":"foreman_tasks","api_url":"/api","name":"Foreman tasks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreman_tasks/summary","name":"summary","apis":[{"api_url":"/foreman_tasks/api/tasks/summary","http_method":"GET","short_description":"Show task summary","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/tasks/:id","http_method":"GET","short_description":"Show task details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/details","name":"details","apis":[{"api_url":"/foreman_tasks/api/tasks/:id/details","http_method":"GET","short_description":"Show task extended details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_search","name":"bulk_search","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_search","http_method":"POST","short_description":"List dynflow tasks for uuids","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eFor every search it returns the list of tasks that satisfty the condition.\nThe reason for supporting multiple searches is the UI that might be ending\nneeding periodic updates on task status for various searches at the same\ntime. This way, it is possible to get all the task statuses with one\nrequest.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"searches","full_name":"searches","description":"\n\u003cp\u003eList of uuids to fetch info about\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"search_id","full_name":"searches[search_id]","description":"\n\u003cp\u003eArbitraty value for client to identify the the request parts with results.\nIt\u0026#39;s passed in the results to be able to pair the requests and\nresponses properly.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"searches[type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003eresource\u003c/code\u003e, \u003ccode\u003etask\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_id","full_name":"searches[task_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;task\u0026#39;, find the task by the uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"searches[user_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;user\u0026#39;, find tasks for the user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource type we\u0026#39;re searching\nthe tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource id we\u0026#39;re searching\nthe tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"action_types","full_name":"searches[action_types]","description":"\n\u003cp\u003eReturn just tasks of given action type, e.g.\n[“Actions::Katello::Repository::Synchronize”]\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eString\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active_only","full_name":"searches[active_only]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"searches[page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"searches[per_page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_resume","name":"bulk_resume","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_resume","http_method":"POST","short_description":"Resume all paused error tasks","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eResumes all selected resumable tasks. If neither a search query nor an\nexplicit list of task IDs is provided, it tries to resume all tasks in\npaused 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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eResume tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eResume specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_cancel","name":"bulk_cancel","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_cancel","http_method":"POST","short_description":"Cancel selected cancellable tasks","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCancels all selected cancellable tasks. Requires a search query or an\nexplicit 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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eCancel tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eCancel specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_stop","name":"bulk_stop","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_stop","http_method":"POST","short_description":"Stop selected stoppable tasks","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eStops all selected tasks which are not already stopped. Requires a search\nquery 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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eStop tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eStop specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/tasks","http_method":"GET","short_description":"List tasks","deprecated":null},{"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/callback","name":"callback","apis":[{"api_url":"/foreman_tasks/api/tasks/callback","http_method":"POST","short_description":"Send data to the task from external executor (such as smart_proxy_dynflow)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"callback","full_name":"callback","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"task_id","full_name":"callback[task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"step_id","full_name":"callback[step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"data","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"callbacks","full_name":"callbacks","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"callback","full_name":"callbacks[callback]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"task_id","full_name":"callbacks[callback][task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"step_id","full_name":"callbacks[callback][step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"callbacks[data]","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreign_input_sets":{"doc_url":"../apidoc/v2/foreign_input_sets","id":"foreign_input_sets","api_url":"/api","name":"Foreign input sets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreign_input_sets/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"GET","short_description":"List foreign input sets","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"GET","short_description":"Show foreign input set details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"POST","short_description":"Create a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"DELETE","short_description":"Delete a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"PUT","short_description":"Update a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_invocations":{"doc_url":"../apidoc/v2/job_invocations","id":"job_invocations","api_url":"/api","name":"Job invocations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/job_invocations/index","name":"index","apis":[{"api_url":"/api/job_invocations","http_method":"GET","short_description":"List job invocations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/show","name":"show","apis":[{"api_url":"/api/job_invocations/:id","http_method":"GET","short_description":"Show job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_status","full_name":"host_status","description":"\n\u003cp\u003eShow Job status for the hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/create","name":"create","apis":[{"api_url":"/api/job_invocations","http_method":"POST","short_description":"Create a job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_invocation","full_name":"job_invocation","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"job_template_id","full_name":"job_invocation[job_template_id]","description":"\n\u003cp\u003eThe job template to use, parameter is required unless feature was specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"targeting_type","full_name":"job_invocation[targeting_type]","description":"\n\u003cp\u003eInvocation type, one of {“static_query”=\u0026gt;“Static Query”,\n“dynamic_query”=\u0026gt;“Dynamic Query”}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"randomized_ordering","full_name":"job_invocation[randomized_ordering]","description":"\n\u003cp\u003eExecute the jobs on hosts in randomized order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inputs","full_name":"job_invocation[inputs]","description":"\n\u003cp\u003eInputs to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"ssh","full_name":"job_invocation[ssh]","description":"\n\u003cp\u003eSSH provider specific options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"effective_user","full_name":"job_invocation[ssh][effective_user]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms).\nDefaults to a template parameter or global setting.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"recurrence","full_name":"job_invocation[recurrence]","description":"\n\u003cp\u003eCreate a recurring job\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"cron_line","full_name":"job_invocation[recurrence][cron_line]","description":"\n\u003cp\u003eHow often the job should occur, in the cron format\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_iteration","full_name":"job_invocation[recurrence][max_iteration]","description":"\n\u003cp\u003eRepeat a maximum of N times\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"end_time","full_name":"job_invocation[recurrence][end_time]","description":"\n\u003cp\u003ePerform no more executions after this time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"scheduling","full_name":"job_invocation[scheduling]","description":"\n\u003cp\u003eSchedule the job to start at a later time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"start_at","full_name":"job_invocation[scheduling][start_at]","description":"\n\u003cp\u003eSchedule the job for a future time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_before","full_name":"job_invocation[scheduling][start_before]","description":"\n\u003cp\u003eIndicates that the action should be cancelled if it cannot be started\nbefore this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"concurrency_control","full_name":"job_invocation[concurrency_control]","description":"\n\u003cp\u003eControl concurrency level and distribution over time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"time_span","full_name":"job_invocation[concurrency_control][time_span]","description":"\n\u003cp\u003eDistribute tasks over N seconds\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"concurrency_level","full_name":"job_invocation[concurrency_control][concurrency_level]","description":"\n\u003cp\u003eRun at most N tasks at a time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"bookmark_id","full_name":"job_invocation[bookmark_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search_query","full_name":"job_invocation[search_query]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_invocation[description_format]","description":"\n\u003cp\u003eOverride the description format from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"execution_timeout_interval","full_name":"job_invocation[execution_timeout_interval]","description":"\n\u003cp\u003eOverride the timeout interval from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"feature","full_name":"job_invocation[feature]","description":"\n\u003cp\u003eRemote execution feature label that should be triggered, job template\nassigned to this feature will be used\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/output","name":"output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id","http_method":"GET","short_description":"Get output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/raw_output","name":"raw_output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id/raw","http_method":"GET","short_description":"Get raw output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/cancel","name":"cancel","apis":[{"api_url":"/api/job_invocations/:id/cancel","http_method":"POST","short_description":"Cancel job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/rerun","name":"rerun","apis":[{"api_url":"/api/job_invocations/:id/rerun","http_method":"POST","short_description":"Rerun job on failed hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"failed_only","full_name":"failed_only","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"since","full_name":"since","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"raw","full_name":"raw","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_templates":{"doc_url":"../apidoc/v2/job_templates","id":"job_templates","api_url":"/api","name":"Job templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/job_templates/index","name":"index","apis":[{"api_url":"/api/job_templates","http_method":"GET","short_description":"List job templates","deprecated":null},{"api_url":"/api/locations/:location_id/job_templates","http_method":"GET","short_description":"List job templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/job_templates","http_method":"GET","short_description":"List job templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/import","name":"import","apis":[{"api_url":"/api/job_templates/import","http_method":"POST","short_description":"Import a job template from ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"template","description":"\n\u003cp\u003eTemplate ERB\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overwrite","full_name":"overwrite","description":"\n\u003cp\u003eOverwrite template if it already exists\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/export","name":"export","apis":[{"api_url":"/api/job_templates/:id/export","http_method":"GET","short_description":"Export a job template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/show","name":"show","apis":[{"api_url":"/api/job_templates/:id","http_method":"GET","short_description":"Show job template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/create","name":"create","apis":[{"api_url":"/api/job_templates","http_method":"POST","short_description":"Create a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"job_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the\ninvocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/update","name":"update","apis":[{"api_url":"/api/job_templates/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"job_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the\ninvocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/revision","name":"revision","apis":[{"api_url":"/api/job_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eTemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/destroy","name":"destroy","apis":[{"api_url":"/api/job_templates/:id","http_method":"DELETE","short_description":"Delete a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/clone","name":"clone","apis":[{"api_url":"/api/job_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"remote_execution_features":{"doc_url":"../apidoc/v2/remote_execution_features","id":"remote_execution_features","api_url":"/api","name":"Remote execution features","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/remote_execution_features/index","name":"index","apis":[{"api_url":"/api/remote_execution_features","http_method":"GET","short_description":"List remote execution features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/remote_execution_features/show","name":"show","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"GET","short_description":"Show remote execution feature","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/remote_execution_features/update","name":"update","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_execution_feature","full_name":"remote_execution_feature","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"job_template_id","full_name":"remote_execution_feature[job_template_id]","description":"\n\u003cp\u003eJob template ID to be used for the feature\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_invocations":{"doc_url":"../apidoc/v2/template_invocations","id":"template_invocations","api_url":"/api","name":"Template invocations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_invocations/template_invocations","name":"template_invocations","apis":[{"api_url":"/api/job_invocations/:job_invocation_id/template_invocations","http_method":"GET","short_description":"List template invocations belonging to job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"job_invocation_id","full_name":"job_invocation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products":{"doc_url":"../apidoc/v2/products","id":"products","api_url":"/api","name":"Products","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products/index","name":"index","apis":[{"api_url":"/katello/api/products","http_method":"GET","short_description":"List products","deprecated":null},{"api_url":"/katello/api/subscriptions/:subscription_id/products","http_method":"GET","short_description":"List of subscription products in a subscription","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/products","http_method":"GET","short_description":"List of subscription products in an activation key","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/products","http_method":"GET","short_description":"List of products in an organization","deprecated":null},{"api_url":"/katello/api/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter products by organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eFilter products by subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eFilter products by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eReturn enabled products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"custom","full_name":"custom","description":"\n\u003cp\u003eReturn custom products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"redhat_only","full_name":"redhat_only","description":"\n\u003cp\u003eReturn Red Hat (non-custom) products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_available_content","full_name":"include_available_content","description":"\n\u003cp\u003eWhether to include available content attribute in results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003eFilter products by sync plan id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Products that can be associated\nwith specified object. Only \u0026#39;sync_plan\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/create","name":"create","apis":[{"api_url":"/katello/api/products","http_method":"POST","short_description":"Create a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/show","name":"show","apis":[{"api_url":"/katello/api/products/:id","http_method":"GET","short_description":"Show a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/update","name":"update","apis":[{"api_url":"/katello/api/products/:id","http_method":"PUT","short_description":"Updates a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/destroy","name":"destroy","apis":[{"api_url":"/katello/api/products/:id","http_method":"DELETE","short_description":"Destroy a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/sync","name":"sync","apis":[{"api_url":"/katello/api/products/:id/sync","http_method":"POST","short_description":"Sync all repositories for a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"activation_keys":{"doc_url":"../apidoc/v2/activation_keys","id":"activation_keys","api_url":"/api","name":"Activation keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/activation_keys/index","name":"index","apis":[{"api_url":"/katello/api/activation_keys","http_method":"GET","short_description":"List activation keys","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eactivation key name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"addon","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"environment","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"usage","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/create","name":"create","apis":[{"api_url":"/katello/api/activation_keys","http_method":"POST","short_description":"Create an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"\n\u003cp\u003eenvironment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/update","name":"update","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"PUT","short_description":"Update an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"DELETE","short_description":"Destroy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/show","name":"show","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"GET","short_description":"Show an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/copy","name":"copy","apis":[{"api_url":"/katello/api/activation_keys/:id/copy","http_method":"POST","short_description":"Copy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003eName of new activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_host_collections","name":"available_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections/available","http_method":"GET","short_description":"List host collections the activation key does not belong to","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_releases","name":"available_releases","apis":[{"api_url":"/katello/api/activation_keys/:id/releases","http_method":"GET","short_description":"Show release versions available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/product_content","name":"product_content","apis":[{"api_url":"/katello/api/activation_keys/:id/product_content","http_method":"GET","short_description":"Show content available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the activation key\u0026#39;s content\nview version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_host_collections","name":"add_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to associate with activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_host_collections","name":"remove_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to disassociate from the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/add_subscriptions","http_method":"PUT","short_description":"Attach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eQuantity of this subscription to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/remove_subscriptions","http_method":"PUT","short_description":"Unattach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/content_override","name":"content_override","apis":[{"api_url":"/katello/api/activation_keys/:id/content_override","http_method":"PUT","short_description":"Override content for activation_key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters to be added in bulk\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride parameter key or name. Note if name is not provided the default\nname will be \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"simple_content_access":{"doc_url":"../apidoc/v2/simple_content_access","id":"simple_content_access","api_url":"/api","name":"Simple content access","short_description":null,"full_description":"\n\u003cp\u003eRed Hat subscriptions management platform.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/simple_content_access/eligible","name":"eligible","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/eligible","http_method":"GET","short_description":"Check if the specified organization is eligible for Simple Content Access","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/simple_content_access/enable","name":"enable","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/enable","http_method":"PUT","short_description":"Enable simple content access for a manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/simple_content_access/disable","name":"disable","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/disable","http_method":"PUT","short_description":"Disable simple content access for a manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"ansible_collections":{"doc_url":"../apidoc/v2/ansible_collections","id":"ansible_collections","api_url":"/api","name":"Ansible Collections","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ansible_collections/index","name":"index","apis":[{"api_url":"/katello/api/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_collections/show","name":"show","apis":[{"api_url":"/katello/api/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ansible collection identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_collections/compare","name":"compare","apis":[{"api_url":"/katello/api/ansible_collections/compare","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"puppet_modules":{"doc_url":"../apidoc/v2/puppet_modules","id":"puppet_modules","api_url":"/api","name":"Puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea puppet module identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/compare","name":"compare","apis":[{"api_url":"/katello/api/puppet_modules/compare","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"capsule_content":{"doc_url":"../apidoc/v2/capsule_content","id":"capsule_content","api_url":"/api","name":"Capsule content","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsule_content/lifecycle_environments","name":"lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/available_lifecycle_environments","name":"available_lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/available_lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments not attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/add_lifecycle_environment","name":"add_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"POST","short_description":"Add lifecycle environments to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/remove_lifecycle_environment","name":"remove_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments/:environment_id","http_method":"DELETE","short_description":"Remove lifecycle environments from the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync","name":"sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"POST","short_description":"Synchronize the content to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit the synchronization on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eSkip metadata check on each repository on the smart proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync_status","name":"sync_status","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"GET","short_description":"Get current smart proxy synchronization status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to get the status for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/cancel_sync","name":"cancel_sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"DELETE","short_description":"Cancel running smart proxy synchronization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"capsules":{"doc_url":"../apidoc/v2/capsules","id":"capsules","api_url":"/api","name":"Capsules","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsules/index","name":"index","apis":[{"api_url":"/katello/api/capsules","http_method":"GET","short_description":"List all smart proxies that have content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsules/show","name":"show","apis":[{"api_url":"/katello/api/capsules/:id","http_method":"GET","short_description":"Show the smart proxy details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"srpms":{"doc_url":"../apidoc/v2/srpms","id":"srpms","api_url":"/api","name":"Srpms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/srpms/index","name":"index","apis":[{"api_url":"/katello/api/srpms","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/srpms/show","name":"show","apis":[{"api_url":"/katello/api/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSRPM details identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/srpms/compare","name":"compare","apis":[{"api_url":"/katello/api/srpms/compare","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_credentials":{"doc_url":"../apidoc/v2/content_credentials","id":"content_credentials","api_url":"/api","name":"Content credentials","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eContent Credentials are used to store credentials like GPG Keys and\nCertificates for the authentication to Products / Repositories.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_credentials/index","name":"index","apis":[{"api_url":"/katello/api/content_credentials","http_method":"GET","short_description":"List Content Credentials","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the Content Credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eType of content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/create","name":"create","apis":[{"api_url":"/katello/api/content_credentials","http_method":"POST","short_description":"Create a Content Credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\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":[]},{"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":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003ePublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/show","name":"show","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"GET","short_description":"Show a Content Credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/update","name":"update","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"PUT","short_description":"Update a Content Credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Credential ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the Content Credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eType of content: “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":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003ePublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"DELETE","short_description":"Destroy a Content Credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Credential ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/content","name":"content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"GET","short_description":"Return the content of a Content Credential, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/set_content","name":"set_content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"POST","short_description":"Upload Content Credential contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent Credential ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eFile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"module_streams":{"doc_url":"../apidoc/v2/module_streams","id":"module_streams","api_url":"/api","name":"Module streams","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/module_streams/index","name":"index","apis":[{"api_url":"/katello/api/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host id to list available module streams for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"name_stream_only","full_name":"name_stream_only","description":"\n\u003cp\u003eReturn name and stream information only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/module_streams/show","name":"show","apis":[{"api_url":"/katello/api/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea module stream identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/module_streams/compare","name":"compare","apis":[{"api_url":"/katello/api/module_streams/compare","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"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":null,"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":[]},{"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":[]},{"name":"chunk_size_mb","full_name":"chunk_size_mb","description":"\n\u003cp\u003eSplit the exported content into archives no greater than the specified size\nin megabytes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"from_history_id","full_name":"from_history_id","description":"\n\u003cp\u003eExport history identifier used for incremental export. If not provided the\nmost 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":[]},{"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\nunexportable. 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":[]}],"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":[]},{"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":[]},{"name":"chunk_size_mb","full_name":"chunk_size_mb","description":"\n\u003cp\u003eSplit the exported content into archives no greater than the specified size\nin megabytes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"from_history_id","full_name":"from_history_id","description":"\n\u003cp\u003eExport history identifier used for incremental export. If not provided the\nmost 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":[]},{"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\nunexportable. 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":[]}],"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":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of a host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eActivation key ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eObject to show subscriptions available for, either \u0026#39;host\u0026#39; or\n\u0026#39;activation_key\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"match_host","full_name":"match_host","description":"\n\u003cp\u003eIgnore subscriptions that are unavailable to the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"match_installed","full_name":"match_installed","description":"\n\u003cp\u003eReturn subscriptions that match installed products of the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"no_overlap","full_name":"no_overlap","description":"\n\u003cp\u003eReturn subscriptions which do not overlap with a currently-attached\nsubscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null},{"api_url":"/katello/api/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/upload","name":"upload","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eSubscription manifest file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]},{"name":"repository_url","full_name":"repository_url","description":"\n\u003cp\u003erepository url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/refresh_manifest","name":"refresh_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/refresh_manifest","http_method":"PUT","short_description":"Refresh previously imported manifest for Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/delete_manifest","name":"delete_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/delete_manifest","http_method":"POST","short_description":"Delete manifest from Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/manifest_history","name":"manifest_history","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/manifest_history","http_method":"GET","short_description":"obtain manifest history for subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_exports":{"doc_url":"../apidoc/v2/content_exports","id":"content_exports","api_url":"/api","name":"Content exports","short_description":null,"full_description":null,"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":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\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":[]},{"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":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"content_view_version_id","type":"integer"},{"name":"id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_exports/api_status","name":"api_status","apis":[{"api_url":"/katello/api/content_exports/api_status","http_method":"GET","short_description":"true if the export api is pulp3 ready and usable. This API is intended for use by hammer-cli only.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"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":[]},{"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":[]},{"name":"chunk_size_mb","full_name":"chunk_size_mb","description":"\n\u003cp\u003eSplit the exported content into archives no greater than the specified size\nin megabytes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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\nunexportable. 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":[]}],"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":[]},{"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":[]},{"name":"chunk_size_mb","full_name":"chunk_size_mb","description":"\n\u003cp\u003eSplit the exported content into archives no greater than the specified size\nin megabytes.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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\nunexportable. 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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"sync":{"doc_url":"../apidoc/v2/sync","id":"sync","api_url":"/api","name":"Sync","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/products/:product_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given product","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/sync","http_method":"GET","short_description":"Get status of synchronisation for given repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_imports":{"doc_url":"../apidoc/v2/content_imports","id":"content_imports","api_url":"/api","name":"Content imports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"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":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"metadata","full_name":"metadata","description":"\n\u003cp\u003eMetadata taken from the upstream export history for this Content View\nVersion\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":[]},{"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":[]},{"name":"metadata","full_name":"metadata","description":"\n\u003cp\u003eMetadata taken from the upstream export history for this Content View\nVersion\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"sync_plans":{"doc_url":"../apidoc/v2/sync_plans","id":"sync_plans","api_url":"/api","name":"Sync plans","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync_plans/index","name":"index","apis":[{"api_url":"/katello/api/sync_plans","http_method":"GET","short_description":"List sync plans","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003efilter by sync date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003efilter by interval\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"enabled","values":["true","false"]},{"name":"interval","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"POST","short_description":"Create a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/add_products","name":"add_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/add_products","http_method":"PUT","short_description":"Add products to sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to add to the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/remove_products","name":"remove_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/remove_products","http_method":"PUT","short_description":"Remove products from sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to remove from the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/sync","name":"sync","apis":[{"api_url":"/katello/api/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_uploads":{"doc_url":"../apidoc/v2/content_uploads","id":"content_uploads","api_url":"/api","name":"Content uploads","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_uploads/create","name":"create","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads","http_method":"POST","short_description":"Create an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"checksum","full_name":"checksum","description":"\n\u003cp\u003eChecksum of file to upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"PUT","short_description":"Upload a chunk of the file's content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eThe offset in the file where the content starts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eThe actual file contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"DELETE","short_description":"Delete an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_components":{"doc_url":"../apidoc/v2/content_view_components","id":"content_view_components","api_url":"/api","name":"Content view components","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_components/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components","http_method":"GET","short_description":"List components attached to this content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/add_components","name":"add_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/add","http_method":"PUT","short_description":"Add components to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"components","full_name":"components","description":"\n\u003cp\u003eArray of components to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_version_id","full_name":"components[content_view_version_id]","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"components[content_view_id]","description":"\n\u003cp\u003econtent view identifier of the component who\u0026#39;s latest version is\ndesired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"latest","full_name":"components[latest]","description":"\n\u003cp\u003etrue if the latest version of the component\u0026#39;s content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/remove_components","name":"remove_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/remove","http_method":"PUT","short_description":"Remove components from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eArray of content view component IDs to remove. Identifier of the component\nassociation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"GET","short_description":"Show a content view component","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"PUT","short_description":"Update a component associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"latest","full_name":"latest","description":"\n\u003cp\u003etrue if the latest version of the components content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ostree_branches":{"doc_url":"../apidoc/v2/ostree_branches","id":"ostree_branches","api_url":"/api","name":"Ostree branches","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ostree_branches/index","name":"index","apis":[{"api_url":"/katello/api/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ostree_branches/show","name":"show","apis":[{"api_url":"/katello/api/ostree_branches/:id","http_method":"GET","short_description":"Show an ostree branch","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_branches/:id","http_method":"GET","short_description":"Show an ostree branch","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ostree branch identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ostree_branches/compare","name":"compare","apis":[{"api_url":"/katello/api/ostree_branches/compare","http_method":"GET","short_description":"List ostree_branches","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filter_rules":{"doc_url":"../apidoc/v2/content_view_filter_rules","id":"content_view_filter_rules","api_url":"/api","name":"Content view filter rules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filter_rules/index","name":"index","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"GET","short_description":"List filter rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerrata_id of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/create","name":"create","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"POST","short_description":"Create a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [String]","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003epackage group: uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eerratum: IDs or a select all object\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"date_type","full_name":"date_type","description":"\n\u003cp\u003eerratum: search using the \u0026#39;Issued On\u0026#39; or \u0026#39;Updated On\u0026#39;\ncolumn of the errata. Values are \u0026#39;issued\u0026#39;/\u0026#39;updated\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_stream_ids","full_name":"module_stream_ids","description":"\n\u003cp\u003emodule stream ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/show","name":"show","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"GET","short_description":"Show filter rule info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/update","name":"update","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"PUT","short_description":"Update a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag: name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"DELETE","short_description":"Delete a filter rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"upstream_subscriptions":{"doc_url":"../apidoc/v2/upstream_subscriptions","id":"upstream_subscriptions","api_url":"/api","name":"Upstream subscriptions","short_description":null,"full_description":"\n\u003cp\u003eRed Hat subscriptions management platform.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/upstream_subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"GET","short_description":"List available subscriptions from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eThe order to sort the results in. [\u0026#39;asc\u0026#39;, \u0026#39;desc\u0026#39;] Defaults\nto \u0026#39;desc\u0026#39;.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eThe field to sort the data by. Defaults to the created date.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eReturn only the upstream pools which map to the given Katello pool IDs\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"quantities_only","full_name":"quantities_only","description":"\n\u003cp\u003eOnly returns id and quantity fields\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"attachable","full_name":"attachable","description":"\n\u003cp\u003eReturn only subscriptions which can be attached to the upstream allocation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"PUT","short_description":"Update the quantity of one or more subscriptions on an upstream allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of Pools to be updated. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eKatello ID of local pool to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eDesired quantity of the pool\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"DELETE","short_description":"Remove one or more subscriptions from an upstream subscription allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eArray of local pool IDs. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"POST","short_description":"Add subscriptions consumed by a manifest from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of pools to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eCandlepin ID of pool to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eQuantity of entitlements to bind\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/ping","name":"ping","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions/ping","http_method":"GET","short_description":"Check if a connection can be made to Red Hat Subscription Management.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/simple_content_access_eligible","name":"simple_content_access_eligible","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions/simple_content_access/eligible","http_method":"GET","short_description":"Check if the specified organization is eligible for Simple Content Access","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/enable_simple_content_access","name":"enable_simple_content_access","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions/simple_content_access/enable","http_method":"PUT","short_description":"Enable simple content access for a manifest","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/disable_simple_content_access","name":"disable_simple_content_access","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions/simple_content_access/disable","http_method":"PUT","short_description":"Disable simple content access for a manifest","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_view_filters":{"doc_url":"../apidoc/v2/content_view_filters","id":"content_view_filters","api_url":"/api","name":"Content view filters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filters/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"get","short_description":"list filters","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"get","short_description":"list filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter content view filters by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003etypes of filters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_type","values":["rpm","package_group","erratum","docker","modulemd"]},{"name":"inclusion_type","values":["include","exclude"]},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the filter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003etype of filter (e.g. rpm, package_group, erratum, docker, modulemd)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package\nfilter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list.\n(module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default:\ninclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"get","short_description":"show filter info","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"get","short_description":"show filter info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"put","short_description":"update a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"put","short_description":"update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003enew name for the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package\nfilter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list.\n(module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default:\ninclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"package_groups":{"doc_url":"../apidoc/v2/package_groups","id":"package_groups","api_url":"/api","name":"Package groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/package_groups/index","name":"index","apis":[{"api_url":"/katello/api/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/show","name":"show","apis":[{"api_url":"/katello/api/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package group identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/compare","name":"compare","apis":[{"api_url":"/katello/api/package_groups/compare","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/create","name":"create","apis":[{"api_url":"/katello/api/package_group","http_method":"POST","short_description":"Create a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003epackage group description. Defaults to \u003ca href=\":name\"\u003eparams\u003c/a\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_visible","full_name":"user_visible","description":"\n\u003cp\u003eset “user_visible” flag on package group. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mandatory_package_names","full_name":"mandatory_package_names","description":"\n\u003cp\u003emandatory package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"optional_package_names","full_name":"optional_package_names","description":"\n\u003cp\u003eoptional package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"conditional_package_names","full_name":"conditional_package_names","description":"\n\u003cp\u003econditional package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default_package_names","full_name":"default_package_names","description":"\n\u003cp\u003edefault package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/destroy","name":"destroy","apis":[{"api_url":"/katello/api/package_group","http_method":"DELETE","short_description":"Delete a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_histories":{"doc_url":"../apidoc/v2/content_view_histories","id":"content_view_histories","api_url":"/api","name":"Content view histories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_histories/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:id/history","http_method":"GET","short_description":"Show a content view's history","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"packages":{"doc_url":"../apidoc/v2/packages","id":"packages","api_url":"/api","name":"Packages","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/packages/index","name":"index","apis":[{"api_url":"/katello/api/packages","http_method":"GET","short_description":"List packages","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003ePackage identifiers to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable packages for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_applicable","full_name":"packages_restrict_applicable","description":"\n\u003cp\u003eReturn packages that are applicable to one or more hosts (defaults to true\nif host_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_upgradable","full_name":"packages_restrict_upgradable","description":"\n\u003cp\u003eReturn packages that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_latest","full_name":"packages_restrict_latest","description":"\n\u003cp\u003eReturn only the latest version of each package\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn packages that can be added to the specified object. Only the value\n\u0026#39;content_view_version\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/show","name":"show","apis":[{"api_url":"/katello/api/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/compare","name":"compare","apis":[{"api_url":"/katello/api/packages/compare","http_method":"GET","short_description":"List packages","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_puppet_modules":{"doc_url":"../apidoc/v2/content_view_puppet_modules","id":"content_view_puppet_modules","api_url":"/api","name":"Content view puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"GET","short_description":"List content view puppet modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003euuid of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"author","type":"string"},{"name":"content_view_name","type":"string"},{"name":"name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"POST","short_description":"Add a puppet module to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ethe id of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"GET","short_description":"Show a content view puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"PUT","short_description":"Update a puppet module associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"DELETE","short_description":"Remove a puppet module from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products_bulk_actions":{"doc_url":"../apidoc/v2/products_bulk_actions","id":"products_bulk_actions","api_url":"/api","name":"Products bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products_bulk_actions/destroy_products","name":"destroy_products","apis":[{"api_url":"/katello/api/products/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/sync_products","name":"sync_products","apis":[{"api_url":"/katello/api/products/bulk/sync","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Non-yum repositories\nare skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Non-yum\nrepositories (or those with \nOn Demand download policy) are skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_http_proxy","name":"update_http_proxy","apis":[{"api_url":"/katello/api/products/bulk/http_proxy","http_method":"PUT","short_description":"Update the HTTP proxy configuration on the repositories of one or more products.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicy for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eHTTP Proxy identifier to associated\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_sync_plans","name":"update_sync_plans","apis":[{"api_url":"/katello/api/products/bulk/sync_plan","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"plan_id","full_name":"plan_id","description":"\n\u003cp\u003eSync plan identifier to attach\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_versions":{"doc_url":"../apidoc/v2/content_view_versions","id":"content_view_versions","api_url":"/api","name":"Content view versions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_versions/index","name":"index","apis":[{"api_url":"/katello/api/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eFilter versions by environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_module_id","full_name":"puppet_module_id","description":"\n\u003cp\u003eFilter versions by puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eFilter versions by version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"composite_version_id","full_name":"composite_version_id","description":"\n\u003cp\u003eFilter versions that are components in the specified composite version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"triggered_by_id","full_name":"triggered_by_id","description":"\n\u003cp\u003eFilter composite versions whose publish was triggered by the specified\ncomponent version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"repository","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/show","name":"show","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"GET","short_description":"Show content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/promote","name":"promote","apis":[{"api_url":"/katello/api/content_view_versions/:id/promote","http_method":"POST","short_description":"Promote a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"\n\u003cp\u003eforce content view promotion and bypass lifecycle environment restriction\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eIdentifiers for Lifecycle Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version promotion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/update","name":"update","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"PUT","short_description":"Update a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/republish_repositories","name":"republish_repositories","apis":[{"api_url":"/katello/api/content_view_versions/:id/republish_repositories","http_method":"PUT","short_description":"Forces a republish of the version's repositories' metadata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/export","name":"export","apis":[{"api_url":"/katello/api/content_view_versions/:id/export","http_method":"POST","short_description":"Export a content view version. Relevant only for Pulp 2 repositories.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB. Relevant only for Pulp 2 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":[]},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z). Relevant only for\nPulp 2 repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/import","name":"import","apis":[{"api_url":"/katello/api/content_view_versions/import","http_method":"POST","short_description":"Import a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"metadata","full_name":"metadata","description":"\n\u003cp\u003eMetadata taken from the upstream export history for this Content View\nVersion\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"DELETE","short_description":"Remove content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/incremental_update","name":"incremental_update","apis":[{"api_url":"/katello/api/content_view_versions/incremental_update","http_method":"POST","short_description":"Perform an Incremental Update on one or more Content View Versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_environments","full_name":"content_view_version_environments","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_version_id","full_name":"content_view_version_environments[content_view_version_id]","description":"\n\u003cp\u003eContent View Version Ids to perform an incremental update on. May contain\ncomposites as well as one or more components to update.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"content_view_version_environments[environment_ids]","description":"\n\u003cp\u003eThe list of environments to promote the specified Content View Version to\n(replacing the older version)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the new generated Content View Versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resolve_dependencies","full_name":"resolve_dependencies","description":"\n\u003cp\u003eIf true, when adding the specified errata or packages, any needed\ndependencies will be copied as well. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"propagate_all_composites","full_name":"propagate_all_composites","description":"\n\u003cp\u003eIf true, will publish a new composite version using any specified\ncontent_view_version_id that has been promoted to a lifecycle environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"add_content","full_name":"add_content","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"errata_ids","full_name":"add_content[errata_ids]","description":"\n\u003cp\u003eErrata ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"package_ids","full_name":"add_content[package_ids]","description":"\n\u003cp\u003ePackage ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"deb_ids","full_name":"add_content[deb_ids]","description":"\n\u003cp\u003eDeb Package ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"puppet_module_ids","full_name":"add_content[puppet_module_ids]","description":"\n\u003cp\u003ePuppet Module ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"update_hosts","full_name":"update_hosts","description":"\n\u003cp\u003eAfter generating the incremental update, apply the changes to the specified\nhosts. Only Errata are supported currently.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"included","full_name":"update_hosts[included]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"update_hosts[included][search]","description":"\n\u003cp\u003eSearch string for host to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"update_hosts[included][ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"update_hosts[excluded]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"update_hosts[excluded][ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_views":{"doc_url":"../apidoc/v2/content_views","id":"content_views","api_url":"/api","name":"Content views","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_views/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"GET","short_description":"List content views","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"GET","short_description":"List content views","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"nondefault","full_name":"nondefault","description":"\n\u003cp\u003eFilter out default content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"noncomposite","full_name":"noncomposite","description":"\n\u003cp\u003eFilter out composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eFilter only composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"without","full_name":"without","description":"\n\u003cp\u003eDo not include this array of content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"composite","type":"boolean"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eContent view label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eComposite content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"PUT","short_description":"Update a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew name for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/publish","name":"publish","apis":[{"api_url":"/katello/api/content_views/:id/publish","http_method":"POST","short_description":"Publish a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the new published content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"major","description":"\n\u003cp\u003eOverride the major version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"minor","description":"\n\u003cp\u003eOverride the minor version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repos_units","full_name":"repos_units","description":"\n\u003cp\u003eSpecify the list of units in each repo\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"label","full_name":"repos_units[label]","description":"\n\u003cp\u003erepo label\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rpm_filenames","full_name":"repos_units[rpm_filenames]","description":"\n\u003cp\u003elist of rpm filename strings to include in published version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"GET","short_description":"Show a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_modules","name":"available_puppet_modules","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_modules","http_method":"GET","short_description":"Get puppet modules that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003emodule name to restrict modules for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_module_names","name":"available_puppet_module_names","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_module_names","http_method":"GET","short_description":"Get puppet modules names that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove_from_environment","name":"remove_from_environment","apis":[{"api_url":"/katello/api/content_views/:id/environments/:environment_id","http_method":"DELETE","short_description":"Remove a content view from an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove","name":"remove","apis":[{"api_url":"/katello/api/content_views/:id/remove","http_method":"PUT","short_description":"Remove versions and/or environments from a content view and reassign systems and keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eenvironment numeric identifiers to be removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of number","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view version identifiers to be deleted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of number","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"system_content_view_id","full_name":"system_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"system_environment_id","full_name":"system_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"key_content_view_id","full_name":"key_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"key_environment_id","full_name":"key_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"DELETE","short_description":"Delete a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/copy","name":"copy","apis":[{"api_url":"/katello/api/content_views/:id/copy","http_method":"POST","short_description":"Make copy of a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew content view name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"debs":{"doc_url":"../apidoc/v2/debs","id":"debs","api_url":"/api","name":"Deb Packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/debs/index","name":"index","apis":[{"api_url":"/katello/api/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs","http_method":"GET","short_description":"List debs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/debs/show","name":"show","apis":[{"api_url":"/katello/api/debs/:id","http_method":"GET","short_description":"Show a deb","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs/:id","http_method":"GET","short_description":"Show a deb","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea deb identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/debs/compare","name":"compare","apis":[{"api_url":"/katello/api/debs/compare","http_method":"GET","short_description":"List debs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"docker_manifest_lists":{"doc_url":"../apidoc/v2/docker_manifest_lists","id":"docker_manifest_lists","api_url":"/api","name":"Docker manifest lists","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifest_lists/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifest_lists/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest list identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifest_lists/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifest_lists/compare","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_manifests":{"doc_url":"../apidoc/v2/docker_manifests","id":"docker_manifests","api_url":"/api","name":"Docker manifests","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifests/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifests/compare","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_tags":{"doc_url":"../apidoc/v2/docker_tags","id":"docker_tags","api_url":"/api","name":"Docker tags","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_tags/index","name":"index","apis":[{"api_url":"/katello/api/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/show","name":"show","apis":[{"api_url":"/katello/api/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker tag identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_tags/compare","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/repositories","name":"repositories","apis":[{"api_url":"/katello/api/docker_tags/:id/repositories","http_method":"GET","short_description":"List of repositories for a docker meta tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"lifecycle_environments":{"doc_url":"../apidoc/v2/lifecycle_environments","id":"lifecycle_environments","api_url":"/api","name":"Lifecycle environments","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eAn environment is a basic organization structure that groups hosts,\nproducts, repositories, etc. Every host belongs to one environment and\nit\u0026#39;s isolated inside so that it can see only content that is in its\nenvironment.\u003c/p\u003e\n\n\u003cp\u003e## Chains\u003c/p\u003e\n\n\u003cp\u003eEnvironments are ordered into chains and their content (products,\nrepositories, tempaltes, packages) can be moved to an environment only from\nits prior environment. You can have for example chain like:\u003c/p\u003e\n\n\u003cpre\u003eLibrary -\u0026gt; Development -\u0026gt; Testing -\u0026gt; Production\u003c/pre\u003e\n\n\u003cp\u003eEach change in an environment is done through a changeset in an action\ncalled promotion.\u003c/p\u003e\n\n\u003cp\u003e## Library\u003c/p\u003e\n\n\u003cp\u003eLibrary is a special environment that has no ascendant: All the content\nstarts in this environment. More chains can start from the library\nenvironment but no further branching of a chain is enabled.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/lifecycle_environments/index","name":"index","apis":[{"api_url":"/katello/api/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"library","full_name":"library","description":"\n\u003cp\u003eset true if you want to see only library environments\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter only environments containing this name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/show","name":"show","apis":[{"api_url":"/katello/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/create","name":"create","apis":[{"api_url":"/katello/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"POST","short_description":"Create an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"prior_id","full_name":"prior_id","description":"\n\u003cp\u003eID of an environment that is prior to the new environment in the chain. It\nhas to be either the ID of Library or the ID of an environment at the end\nof a chain.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/update","name":"update","apis":[{"api_url":"/katello/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"PUT","short_description":"Update an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003enew name to be given to the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the update action to finish. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/destroy","name":"destroy","apis":[{"api_url":"/katello/api/environments/:id","http_method":"DELETE","short_description":"Destroy an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"DELETE","short_description":"Destroy an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/paths","name":"paths","apis":[{"api_url":"/katello/api/organizations/:organization_id/environments/paths","http_method":"GET","short_description":"List environment paths","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"permission_type","full_name":"permission_type","description":"\n\u003cp\u003eThe associated permission type. One of (readable | promotable) Default:\nreadable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"errata":{"doc_url":"../apidoc/v2/errata","id":"errata","api_url":"/api","name":"Errata","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/errata/index","name":"index","apis":[{"api_url":"/katello/api/errata","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn errata that can be added to the specified object. The values\n\u0026#39;content_view_version\u0026#39; and \u0026#39;content_view_filter are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"bug","type":"string"},{"name":"cve","type":"string"},{"name":"errata_id","type":"string"},{"name":"errata_type","type":"string"},{"name":"id","type":"string"},{"name":"issued","type":"date"},{"name":"modular","values":["true","false"]},{"name":"package","type":"string"},{"name":"package_name","type":"string"},{"name":"reboot_suggested","type":"boolean"},{"name":"repository","type":"string"},{"name":"severity","type":"string"},{"name":"title","type":"string"},{"name":"type","type":"string"},{"name":"updated","type":"date"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/show","name":"show","apis":[{"api_url":"/katello/api/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean erratum identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/compare","name":"compare","apis":[{"api_url":"/katello/api/errata/compare","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/available_errata","name":"available_errata","apis":[{"api_url":"/katello/api/content_view_versions/:id/available_errata","http_method":"GET","short_description":"Return errata that can be added to the Content View Version via an Incremental Update. Will be removed in Katello 4.1.","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"file_units":{"doc_url":"../apidoc/v2/file_units","id":"file_units","api_url":"/api","name":"Files","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/file_units/index","name":"index","apis":[{"api_url":"/katello/api/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/file_units/show","name":"show","apis":[{"api_url":"/katello/api/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea file identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/file_units/compare","name":"compare","apis":[{"api_url":"/katello/api/files/compare","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_collections":{"doc_url":"../apidoc/v2/host_collections","id":"host_collections","api_url":"/api","name":"Host collections","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_collections/show","name":"show","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"GET","short_description":"Show a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/index","name":"index","apis":[{"api_url":"/katello/api/host_collections","http_method":"GET","short_description":"List host collections","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"GET","short_description":"List host collections within an organization","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/host_collections","http_method":"GET","short_description":"List host collections in an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eactivation key identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eFilter products by host id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Host Collections that can be\nassociated with specified object. The value \u0026#39;host\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"host","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/create","name":"create","apis":[{"api_url":"/katello/api/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/update","name":"update","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"PUT","short_description":"Update a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/add_hosts","name":"add_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/add_hosts","http_method":"PUT","short_description":"Add host to the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/remove_hosts","name":"remove_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/remove_hosts","http_method":"PUT","short_description":"Remove hosts from the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/destroy","name":"destroy","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"DELETE","short_description":"Destroy a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/copy","name":"copy","apis":[{"api_url":"/katello/api/host_collections/:id/copy","http_method":"POST","short_description":"Make copy of a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew host collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_debs":{"doc_url":"../apidoc/v2/host_debs","id":"host_debs","api_url":"/api","name":"Host debs","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_debs/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/debs","http_method":"GET","short_description":"List deb packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_errata":{"doc_url":"../apidoc/v2/host_errata","id":"host_errata","api_url":"/api","name":"Host errata","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_errata/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/errata","http_method":"GET","short_description":"List errata available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Content View\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/apply","name":"apply","apis":[{"api_url":"/api/hosts/:host_id/errata/apply","http_method":"PUT","short_description":"Schedule errata for installation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids to install. Will be removed in Katello 4.1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"\n\u003cp\u003eErrata to exclusively include in the action\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for erratum to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of errata ids to perform an action on, (ex: RHSA-2019:1168)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"\n\u003cp\u003eErrata to explicitly exclude in the action. All other applicable errata\nwill be included in the action, unless an included parameter is passed as\nwell.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of errata ids to exclude and not run an action on, (ex:\nRHSA-2019:1168)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/errata/:id","http_method":"GET","short_description":"Retrieve a single errata for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eErrata id of the erratum (RHSA-2012:108)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/applicability","name":"applicability","apis":[{"api_url":"/api/hosts/:host_id/errata/applicability","http_method":"PUT","short_description":"Force regenerate applicability.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_module_streams":{"doc_url":"../apidoc/v2/host_module_streams","id":"host_module_streams","api_url":"/api","name":"Host module streams","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_module_streams/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/module_streams","http_method":"GET","short_description":"List module streams available to the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eStreams based on the host based on their status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eenabled\u003c/code\u003e, \u003ccode\u003edisabled\u003c/code\u003e, \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003einstalled\u003c/code\u003e, \u003ccode\u003eupgradable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_packages":{"doc_url":"../apidoc/v2/host_packages","id":"host_packages","api_url":"/api","name":"Host packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_packages/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/packages","http_method":"GET","short_description":"List packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"arch","type":"string"},{"name":"epoch","type":"string"},{"name":"name","type":"string"},{"name":"nvra","type":"string"},{"name":"nvrea","type":"string"},{"name":"release","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/install","name":"install","apis":[{"api_url":"/api/hosts/:host_id/packages/install","http_method":"PUT","short_description":"Install packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade","name":"upgrade","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003elist of packages names\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade_all","name":"upgrade_all","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade_all","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/remove","name":"remove","apis":[{"api_url":"/api/hosts/:host_id/packages/remove","http_method":"PUT","short_description":"Uninstall packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_tracer":{"doc_url":"../apidoc/v2/host_tracer","id":"host_tracer","api_url":"/api","name":"Host tracer","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_tracer/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/traces","http_method":"GET","short_description":"List services that need restarting on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_tracer/resolve","name":"resolve","apis":[{"api_url":"/api/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":[]},{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"hosts_bulk_actions":{"doc_url":"../apidoc/v2/hosts_bulk_actions","id":"hosts_bulk_actions","api_url":"/api","name":"Hosts bulk actions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_add_host_collections","name":"bulk_add_host_collections","apis":[{"api_url":"/api/hosts/bulk/add_host_collections","http_method":"PUT","short_description":"Add one or more host collections to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_remove_host_collections","name":"bulk_remove_host_collections","apis":[{"api_url":"/api/hosts/bulk/remove_host_collections","http_method":"PUT","short_description":"Remove one or more host collections from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/applicable_errata","name":"applicable_errata","apis":[{"api_url":"/api/hosts/bulk/applicable_errata","http_method":"POST","short_description":"Fetch applicable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/installable_errata","name":"installable_errata","apis":[{"api_url":"/api/hosts/bulk/installable_errata","http_method":"POST","short_description":"Fetch installable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/install_content","name":"install_content","apis":[{"api_url":"/api/hosts/bulk/install_content","http_method":"PUT","short_description":"Install content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;,\n\u0026#39;package_group\u0026#39; and \u0026#39;errata\u0026#39;.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package names, package group names or errata ids)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/update_content","name":"update_content","apis":[{"api_url":"/api/hosts/bulk/update_content","http_method":"PUT","short_description":"Update content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;\nand \u0026#39;package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"update_all","full_name":"update_all","description":"\n\u003cp\u003eUpdates all packages on the host(s)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_content","name":"remove_content","apis":[{"api_url":"/api/hosts/bulk/remove_content","http_method":"PUT","short_description":"Remove content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;\nand \u0026#39;package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/destroy_hosts","name":"destroy_hosts","apis":[{"api_url":"/api/hosts/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/bulk/remove_subscriptions","http_method":"PUT","short_description":"Remove subscriptions from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of specified subscription to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/bulk/add_subscriptions","http_method":"PUT","short_description":"Add subscriptions to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/bulk/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/content_overrides","name":"content_overrides","apis":[{"api_url":"/api/hosts/bulk/content_overrides","http_method":"PUT","short_description":"Set content overrides to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be\n\u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/environment_content_view","name":"environment_content_view","apis":[{"api_url":"/api/hosts/bulk/environment_content_view","http_method":"PUT","short_description":"Assign the environment and content view to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/release_version","name":"release_version","apis":[{"api_url":"/api/hosts/bulk/release_version","http_method":"PUT","short_description":"Assign the release version to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/traces","name":"traces","apis":[{"api_url":"/api/hosts/bulk/traces","http_method":"POST","short_description":"Fetch traces for one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/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":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"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":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"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":[]},{"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":[]},{"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":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/available_incremental_updates","name":"available_incremental_updates","apis":[{"api_url":"/api/hosts/bulk/available_incremental_updates","http_method":"POST","short_description":"Given a set of hosts and errata, lists the content view versions and environments that need updating.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/module_streams","name":"module_streams","apis":[{"api_url":"/api/hosts/bulk/module_streams","http_method":"POST","short_description":"Fetch available module streams for hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"repositories_bulk_actions":{"doc_url":"../apidoc/v2/repositories_bulk_actions","id":"repositories_bulk_actions","api_url":"/api","name":"Repositories bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories_bulk_actions/destroy_repositories","name":"destroy_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories_bulk_actions/sync_repositories","name":"sync_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/sync","http_method":"POST","short_description":"Synchronize repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repositories":{"doc_url":"../apidoc/v2/repositories","id":"repositories","api_url":"/api","name":"Repositories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories/index","name":"index","apis":[{"api_url":"/katello/api/repositories","http_method":"GET","short_description":"List of enabled repositories","deprecated":null},{"api_url":"/katello/api/content_views/:id/repositories","http_method":"GET","short_description":"List of repositories for a content view","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/repositories","http_method":"GET","short_description":"List of repositories in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id/repositories","http_method":"GET","short_description":"List repositories in the environment","deprecated":null},{"api_url":"/katello/api/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories for a product","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories belonging to a product in an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of an organization to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to show repositories of\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of an environment to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eID of a content view to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eID of a content view version to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_id","full_name":"deb_id","description":"\n\u003cp\u003eId of a deb package to find repositories that contain the deb\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"erratum_id","full_name":"erratum_id","description":"\n\u003cp\u003eId of an erratum to find repositories that contain the erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rpm_id","full_name":"rpm_id","description":"\n\u003cp\u003eId of a rpm package to find repositories that contain the rpm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"file_id","full_name":"file_id","description":"\n\u003cp\u003eId of a file to find repositories that contain the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_id","full_name":"ansible_collection_id","description":"\n\u003cp\u003eId of an ansible collection to find repositories that contain the ansible\ncollection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_branch_id","full_name":"ostree_branch_id","description":"\n\u003cp\u003eId of an ostree branch to find repositories that contain that branch\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"library","full_name":"library","description":"\n\u003cp\u003eshow repositories in Library and the default content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"archived","full_name":"archived","description":"\n\u003cp\u003eshow archived repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003elimit to only repositories of this type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003einterpret specified object to return only Repositories that can be\nassociated with specified object. Only \u0026#39;content_view\u0026#39; \u0026amp;\n\u0026#39;content_view_version\u0026#39; are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"with_content","full_name":"with_content","description":"\n\u003cp\u003eonly repositories having at least one of the specified content type ex: rpm\n, erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003edocker_manifest_list\u003c/code\u003e, \u003ccode\u003edocker_tag\u003c/code\u003e, \u003ccode\u003edocker_blob\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003emodulemd\u003c/code\u003e, \u003ccode\u003eerratum\u003c/code\u003e, \u003ccode\u003edistribution\u003c/code\u003e, \u003ccode\u003epackage_category\u003c/code\u003e, \u003ccode\u003epackage_group\u003c/code\u003e, \u003ccode\u003eyum_repo_metadata_file\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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, \u003ccode\u003ebackground\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"container_repository_name","type":"string"},{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"distribution_arch","type":"string"},{"name":"distribution_bootable","type":"boolean"},{"name":"distribution_family","type":"string"},{"name":"distribution_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/create","name":"create","apis":[{"api_url":"/katello/api/repositories","http_method":"POST","short_description":"Create a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the repository\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eProduct the repository belongs to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of repo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_versions","full_name":"os_versions","description":"\n\u003cp\u003eIdentifies whether the repository should be disabled on a client with a\nnon-matching OS version. Pass [] to enable regardless of OS version.\nMaximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39;\nare supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_tags_whitelist","full_name":"docker_tags_whitelist","description":"\n\u003cp\u003eComma-separated list of tags to sync for Container Image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either \u0026#39;immediate\u0026#39; or\n\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":[]},{"name":"download_concurrency","full_name":"download_concurrency","description":"\n\u003cp\u003eUsed to determine download concurrency of the repository in pulp3. Use\nvalue 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":[]},{"name":"mirror_on_sync","full_name":"mirror_on_sync","description":"\n\u003cp\u003etrue if this repository when synced has to be mirrored from the source and\nstale rpms removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are\nsigned by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_policy","full_name":"ostree_upstream_sync_policy","description":"\n\u003cp\u003epolicies for syncing upstream ostree repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elatest\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_depth","full_name":"ostree_upstream_sync_depth","description":"\n\u003cp\u003eif a custom sync policy is chosen for ostree repositories then a\n\u0026#39;depth\u0026#39; value must be provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ecomma-separated list of releases to be 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":[]},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ecomma-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":[]},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ecomma-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":[]},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/repository_types","name":"repository_types","apis":[{"api_url":"/katello/api/repositories/repository_types","http_method":"GET","short_description":"Show the available repository types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"creatable","full_name":"creatable","description":"\n\u003cp\u003eWhen set to \u0026#39;True\u0026#39; repository types that are creatable will be\nreturned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/republish","name":"republish","apis":[{"api_url":"/katello/api/repositories/:id/republish","http_method":"PUT","short_description":"Forces a republish of the specified repository, regenerating metadata and symlinks on the filesystem.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/show","name":"show","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"GET","short_description":"Show a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/sync","name":"sync","apis":[{"api_url":"/katello/api/repositories/:id/sync","http_method":"POST","short_description":"Sync a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"source_url","full_name":"source_url","description":"\n\u003cp\u003etemporarily override feed URL for sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"incremental","full_name":"incremental","description":"\n\u003cp\u003eperform an incremental import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Only used with yum\nrepositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Only used with yum\nrepositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/export","name":"export","apis":[{"api_url":"/katello/api/repositories/:id/export","http_method":"POST","short_description":"Export a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_versions","full_name":"os_versions","description":"\n\u003cp\u003eIdentifies whether the repository should be disabled on a client with a\nnon-matching OS version. Pass [] to enable regardless of OS version.\nMaximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39;\nare supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_tags_whitelist","full_name":"docker_tags_whitelist","description":"\n\u003cp\u003eComma-separated list of tags to sync for Container Image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either \u0026#39;immediate\u0026#39; or\n\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":[]},{"name":"download_concurrency","full_name":"download_concurrency","description":"\n\u003cp\u003eUsed to determine download concurrency of the repository in pulp3. Use\nvalue 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":[]},{"name":"mirror_on_sync","full_name":"mirror_on_sync","description":"\n\u003cp\u003etrue if this repository when synced has to be mirrored from the source and\nstale rpms removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are\nsigned by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_policy","full_name":"ostree_upstream_sync_policy","description":"\n\u003cp\u003epolicies for syncing upstream ostree repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elatest\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_depth","full_name":"ostree_upstream_sync_depth","description":"\n\u003cp\u003eif a custom sync policy is chosen for ostree repositories then a\n\u0026#39;depth\u0026#39; value must be provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ecomma-separated list of releases to be 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":[]},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ecomma-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":[]},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ecomma-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":[]},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"DELETE","short_description":"Destroy a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/remove_content","name":"remove_content","apis":[{"api_url":"/katello/api/repositories/:id/remove_packages","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_docker_manifests","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_puppet_modules","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_content","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove content from a repository\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of content ids to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/upload_content","name":"upload_content","apis":[{"api_url":"/katello/api/repositories/:id/upload_content","http_method":"POST","short_description":"Upload content into the repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent files to upload. Can be a single file or array of files.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/import_uploads","name":"import_uploads","apis":[{"api_url":"/katello/api/repositories/:id/import_uploads","http_method":"PUT","short_description":"Import uploads into a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the ImportUpload action to finish. Default: false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"publish_repository","full_name":"publish_repository","description":"\n\u003cp\u003eWhether or not to regenerate the repository on disk. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uploads","full_name":"uploads","description":"\n\u003cp\u003eArray of uploads to import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"uploads[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_unit_id","full_name":"uploads[content_unit_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"uploads[size]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"checksum","full_name":"uploads[checksum]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"uploads[name]","description":"\n\u003cp\u003eNeeds to only be set for file repositories or docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"digest","full_name":"uploads[digest]","description":"\n\u003cp\u003eNeeds to only be set for docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/gpg_key_content","name":"gpg_key_content","apis":[{"api_url":"/katello/api/repositories/:id/gpg_key_content","http_method":"GET","short_description":"Return the content of a repo gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repository_sets":{"doc_url":"../apidoc/v2/repository_sets","id":"repository_sets","api_url":"/api","name":"Repository sets","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repository_sets/index","name":"index","apis":[{"api_url":"/katello/api/repository_sets","http_method":"GET","short_description":"List repository sets.","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets","http_method":"GET","short_description":"List repository sets for a product.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eRepository set name to search on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eIf true, only return repository sets that have been enabled. Defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"with_active_subscription","full_name":"with_active_subscription","description":"\n\u003cp\u003eIf true, only return repository sets that are associated with an active\nsubscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"with_custom","full_name":"with_custom","description":"\n\u003cp\u003eIf true, return custom repository sets along with redhat repos\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/show","name":"show","apis":[{"api_url":"/katello/api/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/available_repositories","name":"available_repositories","apis":[{"api_url":"/katello/api/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/enable","name":"enable","apis":[{"api_url":"/katello/api/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to enable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/disable","name":"disable","apis":[{"api_url":"/katello/api/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to disable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}},"link_extension":".html"}} \ No newline at end of file From 0c62ff213ecbd8cd8a1a6de47bc9279244f38bf8 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Fri, 23 Apr 2021 09:47:26 +0200 Subject: [PATCH 38/56] update Foreman apidoc to 2.4 --- tests/fixtures/apidoc/foreman.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/fixtures/apidoc/foreman.json b/tests/fixtures/apidoc/foreman.json index d35ba7b2..55a37072 100644 --- a/tests/fixtures/apidoc/foreman.json +++ b/tests/fixtures/apidoc/foreman.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":{"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","id":"template_combinations","api_url":"/api","name":"Template combinations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"architectures":{"doc_url":"../apidoc/v2/architectures","id":"architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"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 String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"../apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template inputs","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"../apidoc/v2/audits","id":"audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"action","type":"string"},{"name":"auditable_id","type":"integer"},{"name":"changes","type":"text"},{"name":"comment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"interface_fqdn","type":"string"},{"name":"interface_ip","type":"string"},{"name":"interface_mac","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_title","type":"string"},{"name":"parameter","type":"string"},{"name":"partition_table","type":"string"},{"name":"provisioning_template","type":"string"},{"name":"puppetclass","type":"string"},{"name":"remote_address","type":"string"},{"name":"request_uuid","type":"string"},{"name":"setting","type":"string"},{"name":"time","type":"datetime"},{"name":"type","values":["operatingsystem","role","ptable","provisioning_template","user","auth_source","compute_resource","host","interface","location","organization","os","override_value","parameter","partition_table","setting","smart_class_parameter","subnet"]},{"name":"user","type":"string"},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"../apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal access tokens","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"../apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth source externals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ping":{"doc_url":"../apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"auth_source_internals":{"doc_url":"../apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth source internals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"plugins":{"doc_url":"../apidoc/v2/plugins","id":"plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","id":"auth_source_ldaps","api_url":"/api","name":"Auth source ldaps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","id":"template_kinds","api_url":"/api","name":"Template kinds","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_sources":{"doc_url":"../apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth sources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"trends":{"doc_url":"../apidoc/v2/trends","id":"trends","api_url":"/api","name":"Trends","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API enpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/trends/index","name":"index","apis":[{"api_url":"/api/trends","http_method":"GET","short_description":"List of trends counters","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/show","name":"show","apis":[{"api_url":"/api/trends/:id","http_method":"GET","short_description":"Show a trend","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/create","name":"create","apis":[{"api_url":"/api/trends","http_method":"POST","short_description":"Create a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/destroy","name":"destroy","apis":[{"api_url":"/api/trends/:id","http_method":"DELETE","short_description":"Delete a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"autosign":{"doc_url":"../apidoc/v2/autosign","id":"autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","id":"usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the Foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","id":"bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"environment","type":"string"},{"name":"hostgroup","type":"string"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","id":"common_parameters","api_url":"/api","name":"Common parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"../apidoc/v2/ptables","id":"ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","id":"compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","id":"puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"key","type":"string"},{"name":"location","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","id":"compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_hosts":{"doc_url":"../apidoc/v2/puppet_hosts","id":"puppet_hosts","api_url":"/api","name":"Puppet hosts","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Remote Execution Plugin.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nRemote Execution Plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","id":"compute_resources","api_url":"/api","name":"Compute resources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"../apidoc/v2/users","id":"users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user if it is not already present.\nOnly another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_groups":{"doc_url":"../apidoc/v2/config_groups","id":"config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"class","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"../apidoc/v2/realms","id":"realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"environment","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","id":"dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"../apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are of the form\n\u003cem\u003ehostname\u003c/em\u003e.\u003cstrong\u003esomewhere.com\u003c/strong\u003e then the domain is\n\u003cstrong\u003esomewhere.com\u003c/strong\u003e. This allows Foreman to associate a puppet\nvariable with a domain/site and automatically append this variable to all\nexternal node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003efullname\u003c/strong\u003e field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"environments":{"doc_url":"../apidoc/v2/environments","id":"environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/environments","http_method":"GET","short_description":"List environments of Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/environments","http_method":"GET","short_description":"List environments per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"registration":{"doc_url":"../apidoc/v2/registration","id":"registration","api_url":"/api","name":"Registration","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/registration/global","name":"global","apis":[{"api_url":"/api/register","http_method":"GET","short_description":"Render Global registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the Organization to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of the Location to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of the Host group to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of the Operating System to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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\nset to true, insights client will be installed and registered on Red Hat\nfamily 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":[]},{"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\nit 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":[]}],"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 registration 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}]},{"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\nset to true, insights client will be installed and registered on Red Hat\nfamily 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":[]},{"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\nit 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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"interfaces":{"doc_url":"../apidoc/v2/interfaces","id":"interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","id":"external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","id":"fact_values","api_url":"/api","name":"Fact values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"../apidoc/v2/home","id":"home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_classes":{"doc_url":"../apidoc/v2/host_classes","id":"host_classes","api_url":"/api","name":"Host classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_classes/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"../apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action\nreturns an url to get resulting report from (see\n\u003cstrong\u003ereport_data\u003c/strong\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use \u0026#39;,\u0026#39; to\nseparate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API\nendpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is\ndelivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn\u0026#39;t\nbeen generated yet, it will return an empty response with http status 204 -\nNoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroup_classes":{"doc_url":"../apidoc/v2/hostgroup_classes","id":"hostgroup_classes","api_url":"/api","name":"Hostgroup classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroup_classes/index","name":"index","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/create","name":"create","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","id":"hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/hostgroups","http_method":"GET","short_description":"List all host groups for a Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"class","type":"string"},{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hosts":{"doc_url":"../apidoc/v2/hosts","id":"hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null},{"api_url":"/api/environments/:environment_id/hosts","http_method":"GET","short_description":"List hosts per environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"boot_time","type":"datetime"},{"name":"build","values":["true","false"]},{"name":"class","type":"string"},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"config_group","type":"string"},{"name":"created_at","type":"datetime"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"environment","type":"string"},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","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":"image","type":"string"},{"name":"installed_at","type":"datetime"},{"name":"ip","type":"string"},{"name":"last_report","type":"datetime"},{"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":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"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":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eglobal\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003econfiguration\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ebuild\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host\u0026#39;s compute attributes that can be used to create a clone\nof this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot),\n(cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE,\nprovision, finish, script, user_data, ZTP, POAP, cloud-init, registration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"../apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"../apidoc/v2/images","id":"images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"../apidoc/v2/locations","id":"locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"../apidoc/v2/roles","id":"roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"../apidoc/v2/media","id":"media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"../apidoc/v2/models","id":"models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"../apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","id":"operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"../apidoc/v2/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"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":"/api/organizations/:id","http_method":"GET","short_description":"Show 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/api/organizations","http_method":"POST","short_description":"Create 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"organization[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"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":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/api/organizations/:id","http_method":"PUT","short_description":"Update 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"organization[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"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":[]},{"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":[]}]},{"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, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"../apidoc/v2/settings","id":"settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","id":"os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"override_values":{"doc_url":"../apidoc/v2/override_values","id":"override_values","api_url":"/api","name":"Override values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/override_values/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"../apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cstrong\u003enested parameters for a host,\ndomain, subnet, host group, operating system\u003c/strong\u003e. If you are looking\nfor \u0026lt;a href=“common_parameters.html”\u0026gt;global parameters\u0026lt;/a\u0026gt;, go\nto \u0026lt;a href=“common_parameters.html”\u0026gt;this link\u0026lt;/a\u0026gt;.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"../apidoc/v2/permissions","id":"permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_class_parameters":{"doc_url":"../apidoc/v2/smart_class_parameters","id":"smart_class_parameters","api_url":"/api","name":"Smart class parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_class_parameters/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters","http_method":"GET","short_description":"List all smart class parameters","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment/Puppet class combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"avoid_duplicates","values":["true","false"]},{"name":"environment","type":"string"},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"},{"name":"puppetclass","type":"string"},{"name":"puppetclass_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"GET","short_description":"Show a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"PUT","short_description":"Update a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"\n\u003cp\u003eWhether the smart class parameter value is managed by Foreman\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003cp\u003eDescription of smart class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"\n\u003cp\u003eValue to use when there is no match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"smart_class_parameter[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"smart_class_parameter[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output. Puppet will\nuse the value defined in the Puppet manifest for this parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"smart_class_parameter[path]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"smart_class_parameter[required]","description":"\n\u003cp\u003eIf true, will raise an error if there is no default value and no matcher\nprovide a value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"smart_class_parameter[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"smart_class_parameter[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"smart_class_parameter[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","id":"smart_proxies","api_url":"/api","name":"Smart proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"../apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"statistics":{"doc_url":"../apidoc/v2/statistics","id":"statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API endpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install the\nForeman Statistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"subnets":{"doc_url":"../apidoc/v2/subnets","id":"subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}},"link_extension":".html"}} \ No newline at end of file +{"docs":{"name":"Foreman","info":"\n\u003cp\u003eForeman API v2 is currently the default API version.\u003c/p\u003e\n","copyright":"","doc_url":"../apidoc/v2","api_url":"/api","resources":{"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","id":"template_combinations","api_url":"/api","name":"Template combinations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"GET","short_description":"DEPRECATED: 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment - DEPRECATED will have no effect\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"POST","short_description":"DEPRECATED: 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment - DEPRECATED will have no effect\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"GET","short_description":"DEPRECATED: 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment - DEPRECATED will have no effect\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"PUT","short_description":"DEPRECATED: 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment - DEPRECATED will have no effect\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"architectures":{"doc_url":"../apidoc/v2/architectures","id":"architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"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 String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"../apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template inputs","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is Fact value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is Variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is Puppet parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is Puppet parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is Fact value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is Variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is Puppet parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is Puppet parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"../apidoc/v2/audits","id":"audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"action","type":"string"},{"name":"auditable_id","type":"integer"},{"name":"changes","type":"text"},{"name":"comment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"interface_fqdn","type":"string"},{"name":"interface_ip","type":"string"},{"name":"interface_mac","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_title","type":"string"},{"name":"parameter","type":"string"},{"name":"partition_table","type":"string"},{"name":"provisioning_template","type":"string"},{"name":"puppetclass","type":"string"},{"name":"remote_address","type":"string"},{"name":"request_uuid","type":"string"},{"name":"setting","type":"string"},{"name":"time","type":"datetime"},{"name":"type","values":["operatingsystem","role","ptable","provisioning_template","user","auth_source","compute_resource","host","interface","location","organization","os","override_value","parameter","partition_table","setting","smart_class_parameter","subnet"]},{"name":"user","type":"string"},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"../apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal access tokens","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"../apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth source externals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ping":{"doc_url":"../apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"auth_source_internals":{"doc_url":"../apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth source internals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"plugins":{"doc_url":"../apidoc/v2/plugins","id":"plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","id":"auth_source_ldaps","api_url":"/api","name":"Auth source ldaps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","id":"template_kinds","api_url":"/api","name":"Template kinds","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_sources":{"doc_url":"../apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth sources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"trends":{"doc_url":"../apidoc/v2/trends","id":"trends","api_url":"/api","name":"Trends","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API enpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/trends/index","name":"index","apis":[{"api_url":"/api/trends","http_method":"GET","short_description":"List of trends counters","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/show","name":"show","apis":[{"api_url":"/api/trends/:id","http_method":"GET","short_description":"Show a trend","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/create","name":"create","apis":[{"api_url":"/api/trends","http_method":"POST","short_description":"Create a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/destroy","name":"destroy","apis":[{"api_url":"/api/trends/:id","http_method":"DELETE","short_description":"Delete a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"autosign":{"doc_url":"../apidoc/v2/autosign","id":"autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","id":"usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the Foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","id":"bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"environment","type":"string"},{"name":"hostgroup","type":"string"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","id":"common_parameters","api_url":"/api","name":"Common parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"../apidoc/v2/ptables","id":"ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","id":"compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","id":"puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"key","type":"string"},{"name":"location","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","id":"compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_hosts":{"doc_url":"../apidoc/v2/puppet_hosts","id":"puppet_hosts","api_url":"/api","name":"Puppet hosts","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Remote Execution Plugin.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nRemote Execution Plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","id":"compute_resources","api_url":"/api","name":"Compute resources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"../apidoc/v2/users","id":"users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user if it is not already present.\nOnly another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_groups":{"doc_url":"../apidoc/v2/config_groups","id":"config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"class","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"../apidoc/v2/realms","id":"realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"environment","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","id":"dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"../apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are of the form\n\u003cem\u003ehostname\u003c/em\u003e.\u003cstrong\u003esomewhere.com\u003c/strong\u003e then the domain is\n\u003cstrong\u003esomewhere.com\u003c/strong\u003e. This allows Foreman to associate a puppet\nvariable with a domain/site and automatically append this variable to all\nexternal node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003efullname\u003c/strong\u003e field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"environments":{"doc_url":"../apidoc/v2/environments","id":"environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/environments","http_method":"GET","short_description":"List environments of Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/environments","http_method":"GET","short_description":"List environments per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"registration":{"doc_url":"../apidoc/v2/registration","id":"registration","api_url":"/api","name":"Registration","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/registration/global","name":"global","apis":[{"api_url":"/api/register","http_method":"GET","short_description":"Render Global registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the Organization to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of the Location to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of the Host group to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of the Operating System to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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\nset to true, insights client will be installed and registered on Red Hat\nfamily 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":[]},{"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\nit 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":[]}],"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 registration 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}]},{"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\nset to true, insights client will be installed and registered on Red Hat\nfamily 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":[]},{"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\nit 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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"interfaces":{"doc_url":"../apidoc/v2/interfaces","id":"interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","id":"external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","id":"fact_values","api_url":"/api","name":"Fact values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"../apidoc/v2/home","id":"home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_classes":{"doc_url":"../apidoc/v2/host_classes","id":"host_classes","api_url":"/api","name":"Host classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_classes/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"../apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action\nreturns an url to get resulting report from (see\n\u003cstrong\u003ereport_data\u003c/strong\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use \u0026#39;,\u0026#39; to\nseparate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API\nendpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is\ndelivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn\u0026#39;t\nbeen generated yet, it will return an empty response with http status 204 -\nNoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroup_classes":{"doc_url":"../apidoc/v2/hostgroup_classes","id":"hostgroup_classes","api_url":"/api","name":"Hostgroup classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroup_classes/index","name":"index","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/create","name":"create","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","id":"hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/hostgroups","http_method":"GET","short_description":"List all host groups for a Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"class","type":"string"},{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hosts":{"doc_url":"../apidoc/v2/hosts","id":"hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null},{"api_url":"/api/environments/:environment_id/hosts","http_method":"GET","short_description":"List hosts per environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"boot_time","type":"datetime"},{"name":"build","values":["true","false"]},{"name":"class","type":"string"},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"config_group","type":"string"},{"name":"created_at","type":"datetime"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"environment","type":"string"},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","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":"id","type":"integer"},{"name":"image","type":"string"},{"name":"installed_at","type":"datetime"},{"name":"ip","type":"string"},{"name":"last_report","type":"datetime"},{"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":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"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":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"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":[]},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"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":[]},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eRedfish\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eglobal\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003econfiguration\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ebuild\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host\u0026#39;s compute attributes that can be used to create a clone\nof this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot),\n(cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE,\nprovision, finish, script, user_data, ZTP, POAP, cloud-init, registration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"../apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"../apidoc/v2/images","id":"images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"../apidoc/v2/locations","id":"locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"../apidoc/v2/roles","id":"roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"../apidoc/v2/media","id":"media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"../apidoc/v2/models","id":"models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"../apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","id":"operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"../apidoc/v2/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"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":"/api/organizations/:id","http_method":"GET","short_description":"Show 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/api/organizations","http_method":"POST","short_description":"Create 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"organization[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"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":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/api/organizations/:id","http_method":"PUT","short_description":"Update 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"organization[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"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":[]},{"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":[]}]},{"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, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"../apidoc/v2/settings","id":"settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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}],"additional_properties":false}],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"Information about the setting","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eOBSOLATED: id of the setting record, doesn\u0026#39;t need to be set in the\nfuture\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eSetting unique name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"value","description":"\n\u003cp\u003eSetting current value. If this setting is encypted, the value will not be\nreturned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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.","expected_type":"string","metadata":null,"show":true},{"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.","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"select_values","full_name":"select_values","description":"\n\u003cp\u003eIf this setting has list of possible values, this includes the list of the\nvalues.\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},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003eDEPRECATED: this will be always application install time and dropped in the\nfuture release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Time","expected_type":"string","metadata":null,"show":true},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003eLast updated. NOTE: this will be reset to application install time, when\nsetting is reset to default value.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Time","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[{"code":200,"description":"Information about the updated setting","is_array":false,"returns_object":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eOBSOLATED: id of the setting record, doesn\u0026#39;t need to be set in the\nfuture\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n\u003cp\u003eSetting unique name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"value","full_name":"value","description":"\n\u003cp\u003eSetting current value. If this setting is encypted, the value will not be\nreturned\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"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.","expected_type":"string","metadata":null,"show":true},{"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.","expected_type":"string","metadata":null,"show":true},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"select_values","full_name":"select_values","description":"\n\u003cp\u003eIf this setting has list of possible values, this includes the list of the\nvalues.\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},{"name":"created_at","full_name":"created_at","description":"\n\u003cp\u003eDEPRECATED: this will be always application install time and dropped in the\nfuture release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Time","expected_type":"string","metadata":null,"show":true},{"name":"updated_at","full_name":"updated_at","description":"\n\u003cp\u003eLast updated. NOTE: this will be reset to application install time, when\nsetting is reset to default value.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Time","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","id":"os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"override_values":{"doc_url":"../apidoc/v2/override_values","id":"override_values","api_url":"/api","name":"Override values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/override_values/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"../apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cstrong\u003enested parameters for a host,\ndomain, subnet, host group, operating system\u003c/strong\u003e. If you are looking\nfor \u0026lt;a href=“common_parameters.html”\u0026gt;global parameters\u0026lt;/a\u0026gt;, go\nto \u0026lt;a href=“common_parameters.html”\u0026gt;this link\u0026lt;/a\u0026gt;.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"../apidoc/v2/permissions","id":"permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_class_parameters":{"doc_url":"../apidoc/v2/smart_class_parameters","id":"smart_class_parameters","api_url":"/api","name":"Smart class parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_class_parameters/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters","http_method":"GET","short_description":"List all smart class parameters","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment/Puppet class combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"avoid_duplicates","values":["true","false"]},{"name":"environment","type":"string"},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"},{"name":"puppetclass","type":"string"},{"name":"puppetclass_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"GET","short_description":"Show a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"PUT","short_description":"Update a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"\n\u003cp\u003eWhether the smart class parameter value is managed by Foreman\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003cp\u003eDescription of smart class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"\n\u003cp\u003eValue to use when there is no match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"smart_class_parameter[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"smart_class_parameter[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output. Puppet will\nuse the value defined in the Puppet manifest for this parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"smart_class_parameter[path]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"smart_class_parameter[required]","description":"\n\u003cp\u003eIf true, will raise an error if there is no default value and no matcher\nprovide a value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"smart_class_parameter[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"smart_class_parameter[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"smart_class_parameter[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","id":"smart_proxies","api_url":"/api","name":"Smart proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"../apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"statistics":{"doc_url":"../apidoc/v2/statistics","id":"statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API endpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install the\nForeman Statistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"subnets":{"doc_url":"../apidoc/v2/subnets","id":"subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}},"link_extension":".html"}} \ No newline at end of file From 37bed0e4b3eb8080bf03133a44610528b57f510e Mon Sep 17 00:00:00 2001 From: Ondrej Prazak Date: Tue, 23 Mar 2021 09:47:56 +0100 Subject: [PATCH 39/56] Do not add certs for http requests When we want to do http requests in foreman.py callback plugin, we still add cert paths into requests. With the following config: [callback_foreman] url='http://centos-devel.example.com' verify_certs=false cert paths will contain default values and requests will fail if there are no certs in default paths. But we do not care about certs since we are doing http. --- plugins/callback/foreman.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/plugins/callback/foreman.py b/plugins/callback/foreman.py index 942d9681..aec35aff 100644 --- a/plugins/callback/foreman.py +++ b/plugins/callback/foreman.py @@ -162,6 +162,8 @@ def set_options(self, task_keys=None, var_options=None, direct=None): if not HAS_REQUESTS: self._disable_plugin(u'The `requests` python module is not installed') + self.session = requests.Session() + if self.foreman_url.startswith('https://'): if not os.path.exists(ssl_cert): self._disable_plugin(u'FOREMAN_SSL_CERT %s not found.' % ssl_cert) @@ -169,9 +171,8 @@ def set_options(self, task_keys=None, var_options=None, direct=None): if not os.path.exists(ssl_key): self._disable_plugin(u'FOREMAN_SSL_KEY %s not found.' % ssl_key) - self.session = requests.Session() - self.session.verify = self._ssl_verify(str(self.get_option('verify_certs'))) - self.session.cert = (ssl_cert, ssl_key) + self.session.verify = self._ssl_verify(str(self.get_option('verify_certs'))) + self.session.cert = (ssl_cert, ssl_key) def _disable_plugin(self, msg): self.disabled = True From 65b28080d8f0e2add1c2645d5116e5eb177c1546 Mon Sep 17 00:00:00 2001 From: yifatmakias Date: Thu, 18 Mar 2021 14:14:15 +0200 Subject: [PATCH 40/56] Fixes #31841 - fix bug in assigning error log level in callback report --- plugins/callback/foreman.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/plugins/callback/foreman.py b/plugins/callback/foreman.py index aec35aff..6f41b10f 100644 --- a/plugins/callback/foreman.py +++ b/plugins/callback/foreman.py @@ -98,9 +98,9 @@ def build_log(data): config_report API. """ for source, msg in data: - if 'failed' in msg: + if msg.get('failed'): level = 'err' - elif 'changed' in msg and msg['changed']: + elif msg.get('changed'): level = 'notice' else: level = 'info' @@ -257,26 +257,27 @@ def send_reports(self, stats): self.items[host] = [] - def append_result(self, result): + def append_result(self, result, failed=False): name = result._task.get_name() host = result._host.get_name() value = result._result + value['failed'] = failed self.items[host].append((name, value)) if 'ansible_facts' in value: self.facts[host].update(value['ansible_facts']) # Ansible callback API def v2_runner_on_failed(self, result, ignore_errors=False): - self.append_result(result) + self.append_result(result, True) def v2_runner_on_unreachable(self, result): - self.append_result(result) + self.append_result(result, True) def v2_runner_on_async_ok(self, result): self.append_result(result) def v2_runner_on_async_failed(self, result): - self.append_result(result) + self.append_result(result, True) def v2_playbook_on_stats(self, stats): self.send_facts() From fe10bb81697d5b87ce96f8a1368350f62efa8f6e Mon Sep 17 00:00:00 2001 From: willtome Date: Mon, 1 Feb 2021 11:54:18 -0500 Subject: [PATCH 41/56] add content views role --- roles/content_views/README.md | 70 +++++++++++++++++++ .../tasks/_create_content_view.yml | 43 ++++++++++++ roles/content_views/tasks/main.yml | 6 ++ 3 files changed, 119 insertions(+) create mode 100644 roles/content_views/README.md create mode 100644 roles/content_views/tasks/_create_content_view.yml create mode 100644 roles/content_views/tasks/main.yml diff --git a/roles/content_views/README.md b/roles/content_views/README.md new file mode 100644 index 00000000..d7e9de0a --- /dev/null +++ b/roles/content_views/README.md @@ -0,0 +1,70 @@ +theforeman.foreman.content_views +================================ + +This role creates and manages Content Views. + +Role Variables +-------------- + +This role supports the [Common Role Variables](https://github.com/theforeman/foreman-ansible-modules/blob/develop/README.md#common-role-variables). + +The main data structure for this role is the list of `foreman_content_views`. Each Content View requires the following fields: + +- `name` - the name of the content view + +Each content view also requires either a list of repositories or components (for a composite content view): +- `repositories` - List of repositories to add to the content view. Each repository requires the following fields: + - `name` - The name of the repository + - `product` - The product which the repository belongs to +- `components` - List of content views to add to the composite content view. Each component requires the following fields: + - `content_view` - The name of the content view + - `content_view_version` - The version of the content view to add, *or* + - `latest` - If `true`, the latest version of the content view will be used + +Additionally you can pass any other parameters accepted by the `content_view` module. + +This role also allows you to create Content View Filters and add them to the Content View by passing a list of `filters`: + +- `filters` - List of filters to create and add to the content view. Each filter needs the following fields: + - `name` - Name of the content view filter + - `filter_type` - Content view filter type. The available types are `rpm`, `package_group`, `erratum`, or `docker` + +Additionally you can pass any other parameters accepted by the `content_view_filter` module. + +Example Playbooks +----------------- + +```yaml +- hosts: localhost + roles: + - role: theforeman.foreman.content_views + vars: + foreman_server_url: https://foreman.example.com + foreman_username: "admin" + foreman_password: "changeme" + foreman_organization: "Default Organization" + foreman_content_views: + - name: RHEL7 + repositories: + - name: Red Hat Enterprise Linux 7 Server (RPMs) + product: 'Red Hat Enterprise Linux Server' + - name: Red Hat Enterprise Linux 7 Server - Extras (RPMs) + product: 'Red Hat Enterprise Linux Server' + - name: Red Hat Satellite Tools 6.8 (for RHEL 7 Server) (RPMs) + product: 'Red Hat Enterprise Linux Server' + - name: BearApp + repositories: + - name: MyApps + product: ACME + filters: + - name: "bear app" + filter_state: "present" + filter_type: "rpm" + rule_name: "bear" + - name: BearAppServer + components: + - content_view: RHEL7 + latest: true + - content_view: BearApp + latest: true +``` diff --git a/roles/content_views/tasks/_create_content_view.yml b/roles/content_views/tasks/_create_content_view.yml new file mode 100644 index 00000000..c44f57b2 --- /dev/null +++ b/roles/content_views/tasks/_create_content_view.yml @@ -0,0 +1,43 @@ +--- +- name: create content view + theforeman.foreman.content_view: + username: "{{ foreman_username | default(omit) }}" + password: "{{ foreman_password | default(omit) }}" + server_url: "{{ foreman_server_url | default(omit) }}" + validate_certs: "{{ foreman_validate_certs | default(omit) }}" + organization: "{{ foreman_organization }}" + name: "{{ content_view.name }}" + auto_publish: "{{ content_view.auto_publish | default(omit) }}" + components: "{{ content_view.components | default(omit) }}" + composite: "{{ content_view.components | default(false) | ternary(true, false) }}" + description: "{{ content_view.description | default(omit) }}" + repositories: "{{ content_view.repositories | default(omit) }}" + solve_dependencies: "{{ content_view.solve_dependencies | default(omit) }}" + +- name: add content view filters + theforeman.foreman.content_view_filter: + username: "{{ foreman_username | default(omit) }}" + password: "{{ foreman_password | default(omit) }}" + server_url: "{{ foreman_server_url | default(omit) }}" + validate_certs: "{{ foreman_validate_certs | default(omit) }}" + organization: "{{ foreman_organization }}" + name: "{{ item.name }}" + content_view: "{{ content_view.name }}" + repositories: "{{ item.repositories | default(omit) }}" + filter_type: "{{ item.filter_type }}" + start_date: "{{ item.start_date | default(omit) }}" + end_date: "{{ item.end_date | default(omit) }}" + types: "{{ item.types | default(omit) }}" + date_type: "{{ item.date_type | default(omit) }}" + inclusion: "{{ item.inclusion | default(omit) }}" + errata_id: "{{ item.errata_id | default(omit) }}" + max_version: "{{ item.max_version | default(omit) }}" + min_version: "{{ item.min_version | default(omit) }}" + rule_name: "{{ item.rule_name | default(omit) }}" + version: "{{ item.version | default(omit) }}" + description: "{{ item.description | default(omit) }}" + architecture: "{{ item.architecture | default(omit) }}" + filter_state: "{{ item.filter_state | default(omit) }}" + original_packages: "{{ item.original_packages | default(omit) }}" + rule_state: "{{ item.rule_state | default(omit) }}" + loop: "{{ content_view.filters | default([]) }}" diff --git a/roles/content_views/tasks/main.yml b/roles/content_views/tasks/main.yml new file mode 100644 index 00000000..48c37fc5 --- /dev/null +++ b/roles/content_views/tasks/main.yml @@ -0,0 +1,6 @@ +--- +- name: create content views + include_tasks: '_create_content_view.yml' + with_items: "{{ foreman_content_views | default([]) }}" + loop_control: + loop_var: content_view From 2cc115ae1359b1f11e6dd3ba9f09abee22ec1f44 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Fri, 23 Apr 2021 09:56:58 +0200 Subject: [PATCH 42/56] add tests --- tests/fixtures/apidoc/content_views_role.json | 1 + tests/test_playbooks/content_views_role.yml | 68 +++ .../fixtures/content_views_role-0.yml | 368 +++++++++++++++ .../fixtures/content_views_role-1.yml | 432 ++++++++++++++++++ .../fixtures/content_views_role-2.yml | 368 +++++++++++++++ .../fixtures/content_views_role-3.yml | 370 +++++++++++++++ 6 files changed, 1607 insertions(+) create mode 100644 tests/fixtures/apidoc/content_views_role.json create mode 100644 tests/test_playbooks/content_views_role.yml create mode 100644 tests/test_playbooks/fixtures/content_views_role-0.yml create mode 100644 tests/test_playbooks/fixtures/content_views_role-1.yml create mode 100644 tests/test_playbooks/fixtures/content_views_role-2.yml create mode 100644 tests/test_playbooks/fixtures/content_views_role-3.yml diff --git a/tests/fixtures/apidoc/content_views_role.json b/tests/fixtures/apidoc/content_views_role.json new file mode 100644 index 00000000..92535092 --- /dev/null +++ b/tests/fixtures/apidoc/content_views_role.json @@ -0,0 +1 @@ +{"docs":{"name":"Foreman","info":"\n\u003cp\u003eForeman API v2 is currently the default API version.\u003c/p\u003e\n","copyright":"","doc_url":"../apidoc/v2","api_url":"/api","resources":{"host_subscriptions":{"doc_url":"../apidoc/v2/host_subscriptions","id":"host_subscriptions","api_url":"/api","name":"Host subscriptions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_subscriptions/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"GET","short_description":"List a host's subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"DELETE","short_description":"Unregister the host as a subscription consumer","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/create","name":"create","apis":[{"api_url":"/api/hosts/subscriptions","http_method":"POST","short_description":"Register a host with subscription and information","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eUUID to use for registered host, random uuid is generated if not provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003eKey-value hash of subscription-manager facts, nesting uses a period\ndelimiter (.)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"hypervisor_guest_uuids","description":"\n\u003cp\u003eUUIDs of the virtual guests from the host\u0026#39;s hypervisor\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products","full_name":"installed_products","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"installed_products[product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"installed_products[product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"installed_products[arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"installed_products[version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003eRelease version of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eA service level for auto-healing process, e.g. SELF-SUPPORT\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"lifecycle_environment_id","description":"\n\u003cp\u003eLifecycle Environment ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent View ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/remove_subscriptions","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eIf specified, remove the first instance of a subscription with matching id\nand quantity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/add_subscriptions","http_method":"PUT","short_description":"Add a subscription to a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/content_override","name":"content_override","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/content_override","http_method":"PUT","short_description":"Set content overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n\u003cp\u003eOverride to a boolean value or \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be\n\u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/product_content","name":"product_content","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/product_content","http_method":"GET","short_description":"Get content and overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the host\u0026#39;s content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/available_release_versions","name":"available_release_versions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/available_release_versions","http_method":"GET","short_description":"Show releases available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"interfaces":{"doc_url":"../apidoc/v2/interfaces","id":"interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"GET","short_description":"Show an interface for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subnets":{"doc_url":"../apidoc/v2/subnets","id":"subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/create","name":"create","apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hosts":{"doc_url":"../apidoc/v2/hosts","id":"hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null},{"api_url":"/api/environments/:environment_id/hosts","http_method":"GET","short_description":"List hosts per environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"activation_key","type":"string"},{"name":"activation_key_id","type":"string"},{"name":"addon","type":"string"},{"name":"addons_status","values":["mismatched","matched","not_specified"]},{"name":"applicable_errata","type":"string"},{"name":"applicable_errata_issued","type":"date"},{"name":"applicable_rpms","type":"string"},{"name":"architecture","type":"string"},{"name":"autoheal","type":"boolean"},{"name":"available_module_stream_name","type":"string"},{"name":"available_module_stream_stream","type":"string"},{"name":"boot_time","type":""},{"name":"build","values":["true","false"]},{"name":"class","type":"string"},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"config_group","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"created_at","type":"datetime"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"environment","type":"string"},{"name":"errata_status","values":["security_needed","errata_needed","updated","unknown"]},{"name":"execution_status","values":["ok","error"]},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","type":"string"},{"name":"has_mac","type":"string"},{"name":"host_collection","type":"string"},{"name":"host_collection_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_id","type":"integer"},{"name":"hostgroup_name","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"hypervisor","type":"boolean"},{"name":"hypervisor_host","type":"string"},{"name":"image","type":"string"},{"name":"installable_errata","type":"string"},{"name":"installed_at","type":"datetime"},{"name":"installed_package","type":"string"},{"name":"installed_package_name","type":"string"},{"name":"ip","type":"string"},{"name":"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_environment","type":"string"},{"name":"lifecycle_environment_id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mac","type":"string"},{"name":"managed","values":["true","false"]},{"name":"model","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"owner","type":"string"},{"name":"owner_id","type":"integer"},{"name":"owner_type","type":"string"},{"name":"params","type":"string"},{"name":"params_name","type":"string"},{"name":"parent_hostgroup","type":"string"},{"name":"pools_expiring_in_days","type":"string"},{"name":"puppet_ca","type":"string"},{"name":"puppet_proxy_id","type":"integer"},{"name":"puppetmaster","type":"string"},{"name":"purpose_status","values":["mismatched","matched","not_specified"]},{"name":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"name":"registered_at","type":"datetime"},{"name":"registered_through","type":"string"},{"name":"release_version","type":"string"},{"name":"role","type":"text"},{"name":"role_status","values":["mismatched","matched","not_specified"]},{"name":"service_level","type":"string"},{"name":"sla_status","values":["mismatched","matched","not_specified"]},{"name":"smart_proxy","type":"string"},{"name":"status.applied","type":"integer"},{"name":"status.enabled","values":["true","false"]},{"name":"status.failed","type":"integer"},{"name":"status.failed_restarts","type":"integer"},{"name":"status.interesting","values":["true","false"]},{"name":"status.pending","type":"integer"},{"name":"status.restarted","type":"integer"},{"name":"status.skipped","type":"integer"},{"name":"subnet","type":"string"},{"name":"subnet.name","type":"text"},{"name":"subnet6","type":"string"},{"name":"subnet6.name","type":"text"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"subscription_status","values":["valid","partial","invalid","unknown","disabled","unsubscribed_hypervisor"]},{"name":"subscription_uuid","type":"string"},{"name":"trace_app","type":"string"},{"name":"trace_app_type","type":"string"},{"name":"trace_helper","type":"string"},{"name":"trace_status","values":["reboot_needed","process_restart_needed","updated"]},{"name":"upgradable_rpms","type":"string"},{"name":"usage","type":"text"},{"name":"usage_status","values":["mismatched","matched","not_specified"]},{"name":"user.firstname","type":"string"},{"name":"user.lastname","type":"string"},{"name":"user.login","type":"string"},{"name":"user.mail","type":"string"},{"name":"usergroup","type":"string"},{"name":"usergroup.name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/show","name":"show","apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/enc","name":"enc","apis":[{"api_url":"/api/hosts/:id/enc","http_method":"GET","short_description":"Get ENC values of host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eglobal\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003econfiguration\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ebuild\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host\u0026#39;s compute attributes that can be used to create a clone\nof this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot),\n(cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host,\nContent_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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE,\nprovision, finish, script, user_data, ZTP, POAP, cloud-init, registration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/host_collections","name":"host_collections","apis":[{"api_url":"/api/hosts/:host_id/host_collections","http_method":"PUT","short_description":"Alter a hosts host collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eThe id of the host to alter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","id":"hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/hostgroups","http_method":"GET","short_description":"List all host groups for a Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"class","type":"string"},{"name":"config_group","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/create","name":"create","apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/update","name":"update","apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/clone","name":"clone","apis":[{"api_url":"/api/hostgroups/:id/clone","http_method":"POST","short_description":"Clone a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host,\nContent_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":[]},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","id":"smart_proxies","api_url":"/api","name":"Smart proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/create","name":"create","apis":[{"api_url":"/api/smart_proxies","http_method":"POST","short_description":"Create a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/update","name":"update","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"PUT","short_description":"Update a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"DELETE","short_description":"Delete a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"../apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template inputs","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"POST","short_description":"Create a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::GpgKey\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"PUT","short_description":"Update a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::GpgKey\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"architectures":{"doc_url":"../apidoc/v2/architectures","id":"architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","id":"template_kinds","api_url":"/api","name":"Template kinds","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"../apidoc/v2/audits","id":"audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"action","type":"string"},{"name":"auditable_id","type":"integer"},{"name":"changes","type":"text"},{"name":"comment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"interface_fqdn","type":"string"},{"name":"interface_ip","type":"string"},{"name":"interface_mac","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_title","type":"string"},{"name":"parameter","type":"string"},{"name":"partition_table","type":"string"},{"name":"provisioning_template","type":"string"},{"name":"puppetclass","type":"string"},{"name":"remote_address","type":"string"},{"name":"request_uuid","type":"string"},{"name":"setting","type":"string"},{"name":"time","type":"datetime"},{"name":"type","values":["role","ptable","provisioning_template","user","filter","architecture","bookmark","compute_profile","config_group","domain","environment","host_class","hostgroup","http_proxy","image","key_pair","medium","model","personal_access_token","report_template","puppetclass","realm","smart_proxy","ssh_key","subnet","usergroup","job_template","job_invocation","remote_execution_feature","katello/repository","katello/host/content_facet","katello/hostgroup/content_facet","katello/host/subscription_facet","katello/activation_key","katello/content_view","katello/gpg_key","katello/host_collection","katello/kt_environment","katello/product","katello/sync_plan","lookup_value","hostgroup_class","auth_source","compute_resource","host","interface","location","organization","os","override_value","parameter","partition_table","setting","smart_class_parameter"]},{"name":"user","type":"string"},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"../apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal access tokens","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"../apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth source externals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/update","name":"update","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"PUT","short_description":"Update an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ping":{"doc_url":"../apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/index","name":"index","apis":[{"api_url":"/katello/api/ping","http_method":"GET","short_description":"Shows status of Katello system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/server_status","name":"server_status","apis":[{"api_url":"/katello/api/status","http_method":"GET","short_description":"Shows version information","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"auth_source_internals":{"doc_url":"../apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth source internals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"plugins":{"doc_url":"../apidoc/v2/plugins","id":"plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","id":"auth_source_ldaps","api_url":"/api","name":"Auth source ldaps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/create","name":"create","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"POST","short_description":"Create an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"trends":{"doc_url":"../apidoc/v2/trends","id":"trends","api_url":"/api","name":"Trends","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API enpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/trends/index","name":"index","apis":[{"api_url":"/api/trends","http_method":"GET","short_description":"List of trends counters","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/show","name":"show","apis":[{"api_url":"/api/trends/:id","http_method":"GET","short_description":"Show a trend","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/create","name":"create","apis":[{"api_url":"/api/trends","http_method":"POST","short_description":"Create a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/destroy","name":"destroy","apis":[{"api_url":"/api/trends/:id","http_method":"DELETE","short_description":"Delete a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"auth_sources":{"doc_url":"../apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth sources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","id":"usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the Foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"autosign":{"doc_url":"../apidoc/v2/autosign","id":"autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"../apidoc/v2/users","id":"users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"last_login_on","type":"datetime"},{"name":"lastname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"login","type":"string"},{"name":"mail","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"usergroup","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user if it is not already present.\nOnly another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","id":"bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/create","name":"create","apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"environment","type":"string"},{"name":"hostgroup","type":"string"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/create","name":"create","apis":[{"api_url":"/api/provisioning_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/build_pxe_default","name":"build_pxe_default","apis":[{"api_url":"/api/provisioning_templates/build_pxe_default","http_method":"POST","short_description":"Update the default PXE menu on all configured TFTP servers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/global_registration","name":"global_registration","apis":[{"api_url":"/api/register","http_method":"GET","short_description":"Render Global Registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","id":"common_parameters","api_url":"/api","name":"Common parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/create","name":"create","apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"../apidoc/v2/ptables","id":"ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/create","name":"create","apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","id":"compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","id":"puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"key","type":"string"},{"name":"location","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","id":"compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/create","name":"create","apis":[{"api_url":"/api/compute_profiles","http_method":"POST","short_description":"Create a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_hosts":{"doc_url":"../apidoc/v2/puppet_hosts","id":"puppet_hosts","api_url":"/api","name":"Puppet hosts","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Remote Execution Plugin.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nRemote Execution Plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","id":"compute_resources","api_url":"/api","name":"Compute resources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show","name":"show","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/create","name":"create","apis":[{"api_url":"/api/compute_resources","http_method":"POST","short_description":"Create a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_images","name":"available_images","apis":[{"api_url":"/api/compute_resources/:id/available_images","http_method":"GET","short_description":"List available images for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_clusters","name":"available_clusters","apis":[{"api_url":"/api/compute_resources/:id/available_clusters","http_method":"GET","short_description":"List available clusters for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_flavors","name":"available_flavors","apis":[{"api_url":"/api/compute_resources/:id/available_flavors","http_method":"GET","short_description":"List available flavors for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_folders","name":"available_folders","apis":[{"api_url":"/api/compute_resources/:id/available_folders","http_method":"GET","short_description":"List available folders for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_zones","name":"available_zones","apis":[{"api_url":"/api/compute_resources/:id/available_zones","http_method":"GET","short_description":"List available zone for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_networks","name":"available_networks","apis":[{"api_url":"/api/compute_resources/:id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/refresh_cache","name":"refresh_cache","apis":[{"api_url":"/api/compute_resources/:id/refresh_cache","http_method":"PUT","short_description":"Refresh Compute Resource Cache","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_virtual_machines","name":"available_virtual_machines","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines","http_method":"GET","short_description":"List available virtual machines for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show_vm","name":"show_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"GET","short_description":"Show a virtual machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/power_vm","name":"power_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id/power","http_method":"PUT","short_description":"Power a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy_vm","name":"destroy_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"DELETE","short_description":"Delete a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_groups":{"doc_url":"../apidoc/v2/config_groups","id":"config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"class","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"../apidoc/v2/realms","id":"realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/create","name":"create","apis":[{"api_url":"/api/realms","http_method":"POST","short_description":"Create a realm","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003ename\u003c/strong\u003e field is used for the name of the realm.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"environment","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/create","name":"create","apis":[{"api_url":"/api/config_reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","id":"dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"../apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are of the form\n\u003cem\u003ehostname\u003c/em\u003e.\u003cstrong\u003esomewhere.com\u003c/strong\u003e then the domain is\n\u003cstrong\u003esomewhere.com\u003c/strong\u003e. This allows Foreman to associate a puppet\nvariable with a domain/site and automatically append this variable to all\nexternal node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003efullname\u003c/strong\u003e field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"environments":{"doc_url":"../apidoc/v2/environments","id":"environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/environments","http_method":"GET","short_description":"List environments of Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/environments","http_method":"GET","short_description":"List environments per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"../apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/create","name":"create","apis":[{"api_url":"/api/report_templates","http_method":"POST","short_description":"Create a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/generate","name":"generate","apis":[{"api_url":"/api/report_templates/:id/generate","http_method":"POST","short_description":"Generate report from a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action\nreturns an url to get resulting report from (see\n\u003cstrong\u003ereport_data\u003c/strong\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use \u0026#39;,\u0026#39; to\nseparate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API\nendpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is\ndelivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn\u0026#39;t\nbeen generated yet, it will return an empty response with http status 204 -\nNoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","id":"external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","id":"fact_values","api_url":"/api","name":"Fact values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/create","name":"create","apis":[{"api_url":"/api/filters","http_method":"POST","short_description":"Create a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"../apidoc/v2/home","id":"home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_classes":{"doc_url":"../apidoc/v2/host_classes","id":"host_classes","api_url":"/api","name":"Host classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_classes/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"../apidoc/v2/roles","id":"roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroup_classes":{"doc_url":"../apidoc/v2/hostgroup_classes","id":"hostgroup_classes","api_url":"/api","name":"Hostgroup classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroup_classes/index","name":"index","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/create","name":"create","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"../apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/create","name":"create","apis":[{"api_url":"/api/http_proxies","http_method":"POST","short_description":"Create an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"../apidoc/v2/images","id":"images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"../apidoc/v2/locations","id":"locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/show","name":"show","apis":[{"api_url":"/api/locations/:id","http_method":"GET","short_description":"Show a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/create","name":"create","apis":[{"api_url":"/api/locations","http_method":"POST","short_description":"Create a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"../apidoc/v2/settings","id":"settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/create","name":"create","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"POST","short_description":"Add an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"../apidoc/v2/media","id":"media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/create","name":"create","apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"../apidoc/v2/models","id":"models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/create","name":"create","apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"../apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","id":"operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"../apidoc/v2/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/katello/api/organizations","http_method":"GET","short_description":"List all organizations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"GET","short_description":"Show organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/katello/api/organizations","http_method":"POST","short_description":"Create organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"PUT","short_description":"Update organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"redhat_repository_url","full_name":"redhat_repository_url","description":"\n\u003cp\u003eRed Hat CDN URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/repo_discover","name":"repo_discover","apis":[{"api_url":"/katello/api/organizations/:id/repo_discover","http_method":"PUT","short_description":"Discover Repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003eBase URL to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eOne of yum or docker\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch pattern (defaults to \u0026#39;*\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/cancel_repo_discover","name":"cancel_repo_discover","apis":[{"api_url":"/katello/api/organizations/:label/cancel_repo_discover","http_method":"PUT","short_description":"Cancel repository discovery","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003ebase url to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/download_debug_certificate","name":"download_debug_certificate","apis":[{"api_url":"/katello/api/organizations/:label/download_debug_certificate","http_method":"GET","short_description":"Download a debug certificate","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/releases","name":"releases","apis":[{"api_url":"/katello/api/organizations/:id/releases","http_method":"GET","short_description":"List available releases in the organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the Organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/redhat_provider","name":"redhat_provider","apis":[{"api_url":"/katello/api/organizations/:id/redhat_provider","http_method":"GET","short_description":"List all :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tasks":{"doc_url":"../apidoc/v2/tasks","id":"tasks","api_url":"/api","name":"Tasks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","id":"os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"GET","short_description":"Show a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","id":"template_combinations","api_url":"/api","name":"Template combinations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"override_values":{"doc_url":"../apidoc/v2/override_values","id":"override_values","api_url":"/api","name":"Override values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/override_values/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"../apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cstrong\u003enested parameters for a host,\ndomain, subnet, host group, operating system\u003c/strong\u003e. If you are looking\nfor \u0026lt;a href=“common_parameters.html”\u0026gt;global parameters\u0026lt;/a\u0026gt;, go\nto \u0026lt;a href=“common_parameters.html”\u0026gt;this link\u0026lt;/a\u0026gt;.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"../apidoc/v2/permissions","id":"permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/resource_types","name":"resource_types","apis":[{"api_url":"/api/permissions/resource_types","http_method":"GET","short_description":"List available resource types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_class_parameters":{"doc_url":"../apidoc/v2/smart_class_parameters","id":"smart_class_parameters","api_url":"/api","name":"Smart class parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_class_parameters/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters","http_method":"GET","short_description":"List all smart class parameters","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment/Puppet class combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"avoid_duplicates","values":["true","false"]},{"name":"environment","type":"string"},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"},{"name":"puppetclass","type":"string"},{"name":"puppetclass_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"GET","short_description":"Show a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"PUT","short_description":"Update a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"\n\u003cp\u003eWhether the smart class parameter value is managed by Foreman\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003cp\u003eDescription of smart class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"\n\u003cp\u003eValue to use when there is no match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"smart_class_parameter[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"smart_class_parameter[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output. Puppet will\nuse the value defined in the Puppet manifest for this parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"smart_class_parameter[path]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"smart_class_parameter[required]","description":"\n\u003cp\u003eIf true, will raise an error if there is no default value and no matcher\nprovide a value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"smart_class_parameter[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"smart_class_parameter[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"smart_class_parameter[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"../apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"statistics":{"doc_url":"../apidoc/v2/statistics","id":"statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API endpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install the\nForeman Statistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"recurring_logics":{"doc_url":"../apidoc/v2/recurring_logics","id":"recurring_logics","api_url":"/api","name":"Recurring logics","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/recurring_logics/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/recurring_logics","http_method":"GET","short_description":"List recurring logics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"GET","short_description":"Show recurring logic details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/update","name":"update","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"PUT","short_description":"Update recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eWhether the recurring logic is enabled or disabled.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/cancel","name":"cancel","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id/cancel","http_method":"POST","short_description":"Cancel recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/bulk_destroy","name":"bulk_destroy","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/bulk_destroy","http_method":"POST","short_description":"Delete recurring logics by search query","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch query\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreman_tasks":{"doc_url":"../apidoc/v2/foreman_tasks","id":"foreman_tasks","api_url":"/api","name":"Foreman tasks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreman_tasks/summary","name":"summary","apis":[{"api_url":"/foreman_tasks/api/tasks/summary","http_method":"GET","short_description":"Show task summary","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/tasks/:id","http_method":"GET","short_description":"Show task details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/details","name":"details","apis":[{"api_url":"/foreman_tasks/api/tasks/:id/details","http_method":"GET","short_description":"Show task extended details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_search","name":"bulk_search","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_search","http_method":"POST","short_description":"List dynflow tasks for uuids","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eFor every search it returns the list of tasks that satisfty the condition.\nThe reason for supporting multiple searches is the UI that might be ending\nneeding periodic updates on task status for various searches at the same\ntime. This way, it is possible to get all the task statuses with one\nrequest.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"searches","full_name":"searches","description":"\n\u003cp\u003eList of uuids to fetch info about\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"search_id","full_name":"searches[search_id]","description":"\n\u003cp\u003eArbitraty value for client to identify the the request parts with results.\nIt\u0026#39;s passed in the results to be able to pair the requests and\nresponses properly.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"searches[type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003eresource\u003c/code\u003e, \u003ccode\u003etask\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_id","full_name":"searches[task_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;task\u0026#39;, find the task by the uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"searches[user_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;user\u0026#39;, find tasks for the user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource type we\u0026#39;re searching\nthe tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource id we\u0026#39;re searching\nthe tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"action_types","full_name":"searches[action_types]","description":"\n\u003cp\u003eReturn just tasks of given action type, e.g.\n[“Actions::Katello::Repository::Synchronize”]\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eString\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active_only","full_name":"searches[active_only]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"searches[page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"searches[per_page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_resume","name":"bulk_resume","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_resume","http_method":"POST","short_description":"Resume all paused error tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eResume tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eResume specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_cancel","name":"bulk_cancel","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_cancel","http_method":"POST","short_description":"Cancel all cancellable tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eCancel tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eCancel specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_stop","name":"bulk_stop","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_stop","http_method":"POST","short_description":"Stop all stoppable tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eStop tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eStop specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/tasks","http_method":"GET","short_description":"List tasks","deprecated":null},{"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/callback","name":"callback","apis":[{"api_url":"/foreman_tasks/api/tasks/callback","http_method":"POST","short_description":"Send data to the task from external executor (such as smart_proxy_dynflow)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"callback","full_name":"callback","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"task_id","full_name":"callback[task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"step_id","full_name":"callback[step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"data","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"callbacks","full_name":"callbacks","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"callback","full_name":"callbacks[callback]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"task_id","full_name":"callbacks[callback][task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"step_id","full_name":"callbacks[callback][step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"callbacks[data]","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreign_input_sets":{"doc_url":"../apidoc/v2/foreign_input_sets","id":"foreign_input_sets","api_url":"/api","name":"Foreign input sets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreign_input_sets/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"GET","short_description":"List foreign input sets","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"GET","short_description":"Show foreign input set details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"POST","short_description":"Create a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"DELETE","short_description":"Delete a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"PUT","short_description":"Update a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_invocations":{"doc_url":"../apidoc/v2/job_invocations","id":"job_invocations","api_url":"/api","name":"Job invocations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/job_invocations/index","name":"index","apis":[{"api_url":"/api/job_invocations","http_method":"GET","short_description":"List job invocations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/show","name":"show","apis":[{"api_url":"/api/job_invocations/:id","http_method":"GET","short_description":"Show job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_status","full_name":"host_status","description":"\n\u003cp\u003eShow Job status for the hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/create","name":"create","apis":[{"api_url":"/api/job_invocations","http_method":"POST","short_description":"Create a job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_invocation","full_name":"job_invocation","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"job_template_id","full_name":"job_invocation[job_template_id]","description":"\n\u003cp\u003eThe job template to use, parameter is required unless feature was specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"targeting_type","full_name":"job_invocation[targeting_type]","description":"\n\u003cp\u003eInvocation type, one of {“static_query”=\u0026gt;“Static Query”,\n“dynamic_query”=\u0026gt;“Dynamic Query”}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"randomized_ordering","full_name":"job_invocation[randomized_ordering]","description":"\n\u003cp\u003eExecute the jobs on hosts in randomized order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inputs","full_name":"job_invocation[inputs]","description":"\n\u003cp\u003eInputs to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"ssh","full_name":"job_invocation[ssh]","description":"\n\u003cp\u003eSSH provider specific options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"effective_user","full_name":"job_invocation[ssh][effective_user]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms).\nDefaults to a template parameter or global setting.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"recurrence","full_name":"job_invocation[recurrence]","description":"\n\u003cp\u003eCreate a recurring job\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"cron_line","full_name":"job_invocation[recurrence][cron_line]","description":"\n\u003cp\u003eHow often the job should occur, in the cron format\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_iteration","full_name":"job_invocation[recurrence][max_iteration]","description":"\n\u003cp\u003eRepeat a maximum of N times\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"end_time","full_name":"job_invocation[recurrence][end_time]","description":"\n\u003cp\u003ePerform no more executions after this time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"scheduling","full_name":"job_invocation[scheduling]","description":"\n\u003cp\u003eSchedule the job to start at a later time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"start_at","full_name":"job_invocation[scheduling][start_at]","description":"\n\u003cp\u003eSchedule the job for a future time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_before","full_name":"job_invocation[scheduling][start_before]","description":"\n\u003cp\u003eIndicates that the action should be cancelled if it cannot be started\nbefore this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"concurrency_control","full_name":"job_invocation[concurrency_control]","description":"\n\u003cp\u003eControl concurrency level and distribution over time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"time_span","full_name":"job_invocation[concurrency_control][time_span]","description":"\n\u003cp\u003eDistribute tasks over N seconds\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"concurrency_level","full_name":"job_invocation[concurrency_control][concurrency_level]","description":"\n\u003cp\u003eRun at most N tasks at a time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"bookmark_id","full_name":"job_invocation[bookmark_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search_query","full_name":"job_invocation[search_query]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_invocation[description_format]","description":"\n\u003cp\u003eOverride the description format from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"execution_timeout_interval","full_name":"job_invocation[execution_timeout_interval]","description":"\n\u003cp\u003eOverride the timeout interval from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"feature","full_name":"job_invocation[feature]","description":"\n\u003cp\u003eRemote execution feature label that should be triggered, job template\nassigned to this feature will be used\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/output","name":"output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id","http_method":"GET","short_description":"Get output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/raw_output","name":"raw_output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id/raw","http_method":"GET","short_description":"Get raw output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/cancel","name":"cancel","apis":[{"api_url":"/api/job_invocations/:id/cancel","http_method":"POST","short_description":"Cancel job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/rerun","name":"rerun","apis":[{"api_url":"/api/job_invocations/:id/rerun","http_method":"POST","short_description":"Rerun job on failed hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"failed_only","full_name":"failed_only","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_templates":{"doc_url":"../apidoc/v2/job_templates","id":"job_templates","api_url":"/api","name":"Job templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/job_templates/index","name":"index","apis":[{"api_url":"/api/job_templates","http_method":"GET","short_description":"List job templates","deprecated":null},{"api_url":"/api/locations/:location_id/job_templates","http_method":"GET","short_description":"List job templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/job_templates","http_method":"GET","short_description":"List job templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/import","name":"import","apis":[{"api_url":"/api/job_templates/import","http_method":"POST","short_description":"Import a job template from ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"template","description":"\n\u003cp\u003eTemplate ERB\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overwrite","full_name":"overwrite","description":"\n\u003cp\u003eOverwrite template if it already exists\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/export","name":"export","apis":[{"api_url":"/api/job_templates/:id/export","http_method":"GET","short_description":"Export a job template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/show","name":"show","apis":[{"api_url":"/api/job_templates/:id","http_method":"GET","short_description":"Show job template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/create","name":"create","apis":[{"api_url":"/api/job_templates","http_method":"POST","short_description":"Create a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"job_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the\ninvocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/update","name":"update","apis":[{"api_url":"/api/job_templates/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"job_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the\ninvocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/revision","name":"revision","apis":[{"api_url":"/api/job_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eTemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/destroy","name":"destroy","apis":[{"api_url":"/api/job_templates/:id","http_method":"DELETE","short_description":"Delete a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/clone","name":"clone","apis":[{"api_url":"/api/job_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"remote_execution_features":{"doc_url":"../apidoc/v2/remote_execution_features","id":"remote_execution_features","api_url":"/api","name":"Remote execution features","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/remote_execution_features/index","name":"index","apis":[{"api_url":"/api/remote_execution_features","http_method":"GET","short_description":"List remote execution features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/remote_execution_features/show","name":"show","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"GET","short_description":"Show remote execution feature","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/remote_execution_features/update","name":"update","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_execution_feature","full_name":"remote_execution_feature","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"job_template_id","full_name":"remote_execution_feature[job_template_id]","description":"\n\u003cp\u003eJob template ID to be used for the feature\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_invocations":{"doc_url":"../apidoc/v2/template_invocations","id":"template_invocations","api_url":"/api","name":"Template invocations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_invocations/template_invocations","name":"template_invocations","apis":[{"api_url":"/api/job_invocations/:job_invocation_id/template_invocations","http_method":"GET","short_description":"List template invocations belonging to job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"job_invocation_id","full_name":"job_invocation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_modules":{"doc_url":"../apidoc/v2/puppet_modules","id":"puppet_modules","api_url":"/api","name":"Puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea puppet module identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/compare","name":"compare","apis":[{"api_url":"/katello/api/puppet_modules/compare","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"activation_keys":{"doc_url":"../apidoc/v2/activation_keys","id":"activation_keys","api_url":"/api","name":"Activation keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/activation_keys/index","name":"index","apis":[{"api_url":"/katello/api/activation_keys","http_method":"GET","short_description":"List activation keys","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eactivation key name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"addon","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"environment","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"usage","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/create","name":"create","apis":[{"api_url":"/katello/api/activation_keys","http_method":"POST","short_description":"Create an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"\n\u003cp\u003eenvironment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/update","name":"update","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"PUT","short_description":"Update an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"DELETE","short_description":"Destroy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/show","name":"show","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"GET","short_description":"Show an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/copy","name":"copy","apis":[{"api_url":"/katello/api/activation_keys/:id/copy","http_method":"POST","short_description":"Copy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003eName of new activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_host_collections","name":"available_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections/available","http_method":"GET","short_description":"List host collections the activation key does not belong to","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_releases","name":"available_releases","apis":[{"api_url":"/katello/api/activation_keys/:id/releases","http_method":"GET","short_description":"Show release versions available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/product_content","name":"product_content","apis":[{"api_url":"/katello/api/activation_keys/:id/product_content","http_method":"GET","short_description":"Show content available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the activation key\u0026#39;s content\nview version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_host_collections","name":"add_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to associate with activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_host_collections","name":"remove_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to disassociate from the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/add_subscriptions","http_method":"PUT","short_description":"Attach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eQuantity of this subscription to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/remove_subscriptions","http_method":"PUT","short_description":"Unattach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/content_override","name":"content_override","apis":[{"api_url":"/katello/api/activation_keys/:id/content_override","http_method":"PUT","short_description":"Override content for activation_key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters to be added in bulk\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride parameter key or name. Note if name is not provided the default\nname will be \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repositories_bulk_actions":{"doc_url":"../apidoc/v2/repositories_bulk_actions","id":"repositories_bulk_actions","api_url":"/api","name":"Repositories bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories_bulk_actions/destroy_repositories","name":"destroy_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories_bulk_actions/sync_repositories","name":"sync_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/sync","http_method":"POST","short_description":"Synchronize repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ansible_collections":{"doc_url":"../apidoc/v2/ansible_collections","id":"ansible_collections","api_url":"/api","name":"Ansible Collections","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ansible_collections/index","name":"index","apis":[{"api_url":"/katello/api/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_collections/show","name":"show","apis":[{"api_url":"/katello/api/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ansible collection identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_collections/compare","name":"compare","apis":[{"api_url":"/katello/api/ansible_collections/compare","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"repositories":{"doc_url":"../apidoc/v2/repositories","id":"repositories","api_url":"/api","name":"Repositories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories/index","name":"index","apis":[{"api_url":"/katello/api/repositories","http_method":"GET","short_description":"List of enabled repositories","deprecated":null},{"api_url":"/katello/api/content_views/:id/repositories","http_method":"GET","short_description":"List of repositories for a content view","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/repositories","http_method":"GET","short_description":"List of repositories in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id/repositories","http_method":"GET","short_description":"List repositories in the environment","deprecated":null},{"api_url":"/katello/api/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories for a product","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories belonging to a product in an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of an organization to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to show repositories of\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of an environment to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eID of a content view to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eID of a content view version to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_id","full_name":"deb_id","description":"\n\u003cp\u003eId of a deb package to find repositories that contain the deb\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"erratum_id","full_name":"erratum_id","description":"\n\u003cp\u003eId of an erratum to find repositories that contain the erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rpm_id","full_name":"rpm_id","description":"\n\u003cp\u003eId of a rpm package to find repositories that contain the rpm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"file_id","full_name":"file_id","description":"\n\u003cp\u003eId of a file to find repositories that contain the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_id","full_name":"ansible_collection_id","description":"\n\u003cp\u003eId of an ansible collection to find repositories that contain the ansible\ncollection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_branch_id","full_name":"ostree_branch_id","description":"\n\u003cp\u003eId of an ostree branch to find repositories that contain that branch\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"library","full_name":"library","description":"\n\u003cp\u003eshow repositories in Library and the default content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"archived","full_name":"archived","description":"\n\u003cp\u003eshow archived repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003elimit to only repositories of this type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003einterpret specified object to return only Repositories that can be\nassociated with specified object. Only \u0026#39;content_view\u0026#39; \u0026amp;\n\u0026#39;content_view_version\u0026#39; are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"with_content","full_name":"with_content","description":"\n\u003cp\u003eonly repositories having at least one of the specified content type ex: rpm\n, erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003edocker_manifest_list\u003c/code\u003e, \u003ccode\u003edocker_tag\u003c/code\u003e, \u003ccode\u003edocker_blob\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003emodulemd\u003c/code\u003e, \u003ccode\u003eerratum\u003c/code\u003e, \u003ccode\u003edistribution\u003c/code\u003e, \u003ccode\u003epackage_category\u003c/code\u003e, \u003ccode\u003epackage_group\u003c/code\u003e, \u003ccode\u003eyum_repo_metadata_file\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"container_repository_name","type":"string"},{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"distribution_arch","type":"string"},{"name":"distribution_bootable","type":"boolean"},{"name":"distribution_family","type":"string"},{"name":"distribution_variant","type":"string"},{"name":"distribution_version","type":"string"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/create","name":"create","apis":[{"api_url":"/katello/api/repositories","http_method":"POST","short_description":"Create a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the repository\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eProduct the repository belongs to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of repo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39;\nare supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_tags_whitelist","full_name":"docker_tags_whitelist","description":"\n\u003cp\u003eComma separated list of tags to sync for Container Image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either \u0026#39;immediate\u0026#39;,\n\u0026#39;on_demand\u0026#39;, or \u0026#39;background (deprecated)\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e, \u003ccode\u003ebackground\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"download_concurrency","full_name":"download_concurrency","description":"\n\u003cp\u003eUsed to determine download concurrency of the repository in pulp3. Use\nvalue 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":[]},{"name":"mirror_on_sync","full_name":"mirror_on_sync","description":"\n\u003cp\u003etrue if this repository when synced has to be mirrored from the source and\nstale rpms removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are\nsigned by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_policy","full_name":"ostree_upstream_sync_policy","description":"\n\u003cp\u003epolicies for syncing upstream ostree repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elatest\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_depth","full_name":"ostree_upstream_sync_depth","description":"\n\u003cp\u003eif a custom sync policy is chosen for ostree repositories then a\n\u0026#39;depth\u0026#39; value must be provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ecomma separated list of releases to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ecomma separated list of repo components to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ecomma separated list of architectures to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ignore_global_proxy","full_name":"ignore_global_proxy","description":"\n\u003cp\u003eif true, will ignore the globally configured proxy when syncing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/repository_types","name":"repository_types","apis":[{"api_url":"/katello/api/repositories/repository_types","http_method":"GET","short_description":"Show the available repository types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"creatable","full_name":"creatable","description":"\n\u003cp\u003eWhen set to \u0026#39;True\u0026#39; repository types that are creatable will be\nreturned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/republish","name":"republish","apis":[{"api_url":"/katello/api/repositories/:id/republish","http_method":"PUT","short_description":"Forces a republish of the specified repository, regenerating metadata and symlinks on the filesystem.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/show","name":"show","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"GET","short_description":"Show a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/sync","name":"sync","apis":[{"api_url":"/katello/api/repositories/:id/sync","http_method":"POST","short_description":"Sync a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"source_url","full_name":"source_url","description":"\n\u003cp\u003etemporarily override feed URL for sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"incremental","full_name":"incremental","description":"\n\u003cp\u003eperform an incremental import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Only used with yum\nrepositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Only used with yum\nrepositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/export","name":"export","apis":[{"api_url":"/katello/api/repositories/:id/export","http_method":"POST","short_description":"Export a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39;\nare supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_tags_whitelist","full_name":"docker_tags_whitelist","description":"\n\u003cp\u003eComma separated list of tags to sync for Container Image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either \u0026#39;immediate\u0026#39;,\n\u0026#39;on_demand\u0026#39;, or \u0026#39;background (deprecated)\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e, \u003ccode\u003ebackground\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"download_concurrency","full_name":"download_concurrency","description":"\n\u003cp\u003eUsed to determine download concurrency of the repository in pulp3. Use\nvalue 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":[]},{"name":"mirror_on_sync","full_name":"mirror_on_sync","description":"\n\u003cp\u003etrue if this repository when synced has to be mirrored from the source and\nstale rpms removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are\nsigned by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_policy","full_name":"ostree_upstream_sync_policy","description":"\n\u003cp\u003epolicies for syncing upstream ostree repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elatest\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_depth","full_name":"ostree_upstream_sync_depth","description":"\n\u003cp\u003eif a custom sync policy is chosen for ostree repositories then a\n\u0026#39;depth\u0026#39; value must be provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ecomma separated list of releases to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ecomma separated list of repo components to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ecomma separated list of architectures to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ignore_global_proxy","full_name":"ignore_global_proxy","description":"\n\u003cp\u003eif true, will ignore the globally configured proxy when syncing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"DELETE","short_description":"Destroy a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/remove_content","name":"remove_content","apis":[{"api_url":"/katello/api/repositories/:id/remove_packages","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_docker_manifests","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_puppet_modules","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_content","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove content from a repository\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of content ids to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/upload_content","name":"upload_content","apis":[{"api_url":"/katello/api/repositories/:id/upload_content","http_method":"POST","short_description":"Upload content into the repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent files to upload. Can be a single file or array of files.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/import_uploads","name":"import_uploads","apis":[{"api_url":"/katello/api/repositories/:id/import_uploads","http_method":"PUT","short_description":"Import uploads into a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the ImportUpload action to finish. Default: false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"publish_repository","full_name":"publish_repository","description":"\n\u003cp\u003eWhether or not to regenerate the repository on disk. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uploads","full_name":"uploads","description":"\n\u003cp\u003eArray of uploads to import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"uploads[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_unit_id","full_name":"uploads[content_unit_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"uploads[size]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"checksum","full_name":"uploads[checksum]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"uploads[name]","description":"\n\u003cp\u003eNeeds to only be set for file repositories or docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"digest","full_name":"uploads[digest]","description":"\n\u003cp\u003eNeeds to only be set for docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/gpg_key_content","name":"gpg_key_content","apis":[{"api_url":"/katello/api/repositories/:id/gpg_key_content","http_method":"GET","short_description":"Return the content of a repo gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"capsule_content":{"doc_url":"../apidoc/v2/capsule_content","id":"capsule_content","api_url":"/api","name":"Capsule content","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsule_content/lifecycle_environments","name":"lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/available_lifecycle_environments","name":"available_lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/available_lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments not attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/add_lifecycle_environment","name":"add_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"POST","short_description":"Add lifecycle environments to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/remove_lifecycle_environment","name":"remove_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments/:environment_id","http_method":"DELETE","short_description":"Remove lifecycle environments from the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync","name":"sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"POST","short_description":"Synchronize the content to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit the synchronization on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eSkip metadata check on each repository on the smart proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync_status","name":"sync_status","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"GET","short_description":"Get current smart proxy synchronization status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to get the status for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/cancel_sync","name":"cancel_sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"DELETE","short_description":"Cancel running smart proxy synchronization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"capsules":{"doc_url":"../apidoc/v2/capsules","id":"capsules","api_url":"/api","name":"Capsules","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsules/index","name":"index","apis":[{"api_url":"/katello/api/capsules","http_method":"GET","short_description":"List all smart proxies that have content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsules/show","name":"show","apis":[{"api_url":"/katello/api/capsules/:id","http_method":"GET","short_description":"Show the smart proxy details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sync_plans":{"doc_url":"../apidoc/v2/sync_plans","id":"sync_plans","api_url":"/api","name":"Sync plans","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync_plans/index","name":"index","apis":[{"api_url":"/katello/api/sync_plans","http_method":"GET","short_description":"List sync plans","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003efilter by sync date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003efilter by interval\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"enabled","values":["true","false"]},{"name":"interval","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"POST","short_description":"Create a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/add_products","name":"add_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/add_products","http_method":"PUT","short_description":"Add products to sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to add to the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/remove_products","name":"remove_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/remove_products","http_method":"PUT","short_description":"Remove products from sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to remove from the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/sync","name":"sync","apis":[{"api_url":"/katello/api/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_credentials":{"doc_url":"../apidoc/v2/content_credentials","id":"content_credentials","api_url":"/api","name":"Content credentials","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eContent Credentials are used to store credentials like GPG Keys and\nCertificates for the authentication to Products / Repositories.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_credentials/index","name":"index","apis":[{"api_url":"/katello/api/content_credentials","http_method":"GET","short_description":"List content credentials","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the Content Credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/create","name":"create","apis":[{"api_url":"/katello/api/content_credentials","http_method":"POST","short_description":"Create a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the content credential\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/show","name":"show","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"GET","short_description":"Show a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/update","name":"update","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"PUT","short_description":"Update a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the content credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"DELETE","short_description":"Destroy a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/content","name":"content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"GET","short_description":"Return the content of a content credential, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/set_content","name":"set_content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"POST","short_description":"Upload content credential contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003efile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"upstream_subscriptions":{"doc_url":"../apidoc/v2/upstream_subscriptions","id":"upstream_subscriptions","api_url":"/api","name":"Upstream subscriptions","short_description":null,"full_description":"\n\u003cp\u003eRed Hat subscriptions management platform.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/upstream_subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"GET","short_description":"List available subscriptions from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eThe order to sort the results in. [\u0026#39;asc\u0026#39;, \u0026#39;desc\u0026#39;] Defaults\nto \u0026#39;desc\u0026#39;.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eThe field to sort the data by. Defaults to the created date.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eReturn only the upstream pools which map to the given Katello pool IDs\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"quantities_only","full_name":"quantities_only","description":"\n\u003cp\u003eOnly returns id and quantity fields\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"attachable","full_name":"attachable","description":"\n\u003cp\u003eReturn only subscriptions which can be attached to the upstream allocation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"PUT","short_description":"Update the quantity of one or more subscriptions on an upstream allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of Pools to be updated. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eKatello ID of local pool to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eDesired quantity of the pool\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"DELETE","short_description":"Remove one or more subscriptions from an upstream subscription allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eArray of local pool IDs. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"POST","short_description":"Add subscriptions consumed by a manifest from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of pools to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eCandlepin ID of pool to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eQuantity of entitlements to bind\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/ping","name":"ping","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions/ping","http_method":"GET","short_description":"Check if a connection can be made to Red Hat Subscription Management.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/enable_simple_content_access","name":"enable_simple_content_access","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/enable","http_method":"PUT","short_description":"Enable simple content access for a manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/disable_simple_content_access","name":"disable_simple_content_access","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/disable","http_method":"PUT","short_description":"Disable simple content access for a 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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_uploads":{"doc_url":"../apidoc/v2/content_uploads","id":"content_uploads","api_url":"/api","name":"Content uploads","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_uploads/create","name":"create","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads","http_method":"POST","short_description":"Create an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"checksum","full_name":"checksum","description":"\n\u003cp\u003eChecksum of file to upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"PUT","short_description":"Upload a chunk of the file's content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eThe offset in the file where the content starts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eThe actual file contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"DELETE","short_description":"Delete an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"packages":{"doc_url":"../apidoc/v2/packages","id":"packages","api_url":"/api","name":"Packages","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/packages/index","name":"index","apis":[{"api_url":"/katello/api/packages","http_method":"GET","short_description":"List packages","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003ePackage identifiers to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable packages for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_applicable","full_name":"packages_restrict_applicable","description":"\n\u003cp\u003eReturn packages that are applicable to one or more hosts (defaults to true\nif host_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_upgradable","full_name":"packages_restrict_upgradable","description":"\n\u003cp\u003eReturn packages that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_latest","full_name":"packages_restrict_latest","description":"\n\u003cp\u003eReturn only the latest version of each package\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn packages that can be added to the specified object. Only the value\n\u0026#39;content_view_version\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/show","name":"show","apis":[{"api_url":"/katello/api/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/compare","name":"compare","apis":[{"api_url":"/katello/api/packages/compare","http_method":"GET","short_description":"List packages","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_components":{"doc_url":"../apidoc/v2/content_view_components","id":"content_view_components","api_url":"/api","name":"Content view components","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_components/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components","http_method":"GET","short_description":"List components attached to this content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/add_components","name":"add_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/add","http_method":"PUT","short_description":"Add components to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"components","full_name":"components","description":"\n\u003cp\u003eArray of components to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_version_id","full_name":"components[content_view_version_id]","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"components[content_view_id]","description":"\n\u003cp\u003econtent view identifier of the component who\u0026#39;s latest version is\ndesired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"latest","full_name":"components[latest]","description":"\n\u003cp\u003etrue if the latest version of the component\u0026#39;s content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/remove_components","name":"remove_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/remove","http_method":"PUT","short_description":"Remove components from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eArray of content view component IDs to remove. Identifier of the component\nassociation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"GET","short_description":"Show a content view component","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"PUT","short_description":"Update a component associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"latest","full_name":"latest","description":"\n\u003cp\u003etrue if the latest version of the components content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"package_groups":{"doc_url":"../apidoc/v2/package_groups","id":"package_groups","api_url":"/api","name":"Package groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/package_groups/index","name":"index","apis":[{"api_url":"/katello/api/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/show","name":"show","apis":[{"api_url":"/katello/api/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package group identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/compare","name":"compare","apis":[{"api_url":"/katello/api/package_groups/compare","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/create","name":"create","apis":[{"api_url":"/katello/api/package_group","http_method":"POST","short_description":"Create a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003epackage group description. Defaults to \u003ca href=\":name\"\u003eparams\u003c/a\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_visible","full_name":"user_visible","description":"\n\u003cp\u003eset “user_visible” flag on package group. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mandatory_package_names","full_name":"mandatory_package_names","description":"\n\u003cp\u003emandatory package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"optional_package_names","full_name":"optional_package_names","description":"\n\u003cp\u003eoptional package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"conditional_package_names","full_name":"conditional_package_names","description":"\n\u003cp\u003econditional package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default_package_names","full_name":"default_package_names","description":"\n\u003cp\u003edefault package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/destroy","name":"destroy","apis":[{"api_url":"/katello/api/package_group","http_method":"DELETE","short_description":"Delete a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filter_rules":{"doc_url":"../apidoc/v2/content_view_filter_rules","id":"content_view_filter_rules","api_url":"/api","name":"Content view filter rules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filter_rules/index","name":"index","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"GET","short_description":"List filter rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerrata_id of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/create","name":"create","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"POST","short_description":"Create a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [String]","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003epackage group: uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eerratum: IDs or a select all object\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"date_type","full_name":"date_type","description":"\n\u003cp\u003eerratum: search using the \u0026#39;Issued On\u0026#39; or \u0026#39;Updated On\u0026#39;\ncolumn of the errata. Values are \u0026#39;issued\u0026#39;/\u0026#39;updated\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_stream_ids","full_name":"module_stream_ids","description":"\n\u003cp\u003emodule stream ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/show","name":"show","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"GET","short_description":"Show filter rule info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/update","name":"update","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"PUT","short_description":"Update a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag: name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"DELETE","short_description":"Delete a filter rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filters":{"doc_url":"../apidoc/v2/content_view_filters","id":"content_view_filters","api_url":"/api","name":"Content view filters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filters/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"get","short_description":"list filters","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"get","short_description":"list filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter content view filters by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003etypes of filters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_type","values":["rpm","package_group","erratum","docker","modulemd"]},{"name":"inclusion_type","values":["include","exclude"]},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the filter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003etype of filter (e.g. rpm, package_group, erratum, docker, modulemd)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package\nfilter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list.\n(module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default:\ninclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"get","short_description":"show filter info","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"get","short_description":"show filter info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"put","short_description":"update a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"put","short_description":"update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003enew name for the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package\nfilter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list.\n(module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default:\ninclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"sync":{"doc_url":"../apidoc/v2/sync","id":"sync","api_url":"/api","name":"Sync","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/products/:product_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given product","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/sync","http_method":"GET","short_description":"Get status of synchronisation for given repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_histories":{"doc_url":"../apidoc/v2/content_view_histories","id":"content_view_histories","api_url":"/api","name":"Content view histories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_histories/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:id/history","http_method":"GET","short_description":"Show a content view's history","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products_bulk_actions":{"doc_url":"../apidoc/v2/products_bulk_actions","id":"products_bulk_actions","api_url":"/api","name":"Products bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products_bulk_actions/destroy_products","name":"destroy_products","apis":[{"api_url":"/katello/api/products/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/sync_products","name":"sync_products","apis":[{"api_url":"/katello/api/products/bulk/sync","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Non-yum repositories\nare skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Non-yum\nrepositories (or those with \nOn Demand download policy) are skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_http_proxy","name":"update_http_proxy","apis":[{"api_url":"/katello/api/products/bulk/http_proxy","http_method":"PUT","short_description":"Update the HTTP proxy configuration on the repositories of one or more products.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicy for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eHTTP Proxy identifier to associated\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_sync_plans","name":"update_sync_plans","apis":[{"api_url":"/katello/api/products/bulk/sync_plan","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"plan_id","full_name":"plan_id","description":"\n\u003cp\u003eSync plan identifier to attach\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_puppet_modules":{"doc_url":"../apidoc/v2/content_view_puppet_modules","id":"content_view_puppet_modules","api_url":"/api","name":"Content view puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"GET","short_description":"List content view puppet modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003euuid of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"author","type":"string"},{"name":"content_view_name","type":"string"},{"name":"name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"POST","short_description":"Add a puppet module to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ethe id of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"GET","short_description":"Show a content view puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"PUT","short_description":"Update a puppet module associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"DELETE","short_description":"Remove a puppet module from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products":{"doc_url":"../apidoc/v2/products","id":"products","api_url":"/api","name":"Products","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products/index","name":"index","apis":[{"api_url":"/katello/api/products","http_method":"GET","short_description":"List products","deprecated":null},{"api_url":"/katello/api/subscriptions/:subscription_id/products","http_method":"GET","short_description":"List of subscription products in a subscription","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/products","http_method":"GET","short_description":"List of subscription products in an activation key","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/products","http_method":"GET","short_description":"List of products in an organization","deprecated":null},{"api_url":"/katello/api/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter products by organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eFilter products by subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eFilter products by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eReturn enabled products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"custom","full_name":"custom","description":"\n\u003cp\u003eReturn custom products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"redhat_only","full_name":"redhat_only","description":"\n\u003cp\u003eReturn Red Hat (non-custom) products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_available_content","full_name":"include_available_content","description":"\n\u003cp\u003eWhether to include available content attribute in results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003eFilter products by sync plan id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Products that can be associated\nwith specified object. Only \u0026#39;sync_plan\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/create","name":"create","apis":[{"api_url":"/katello/api/products","http_method":"POST","short_description":"Create a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/show","name":"show","apis":[{"api_url":"/katello/api/products/:id","http_method":"GET","short_description":"Show a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/update","name":"update","apis":[{"api_url":"/katello/api/products/:id","http_method":"PUT","short_description":"Updates a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/destroy","name":"destroy","apis":[{"api_url":"/katello/api/products/:id","http_method":"DELETE","short_description":"Destroy a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/sync","name":"sync","apis":[{"api_url":"/katello/api/products/:id/sync","http_method":"POST","short_description":"Sync all repositories for a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_view_versions":{"doc_url":"../apidoc/v2/content_view_versions","id":"content_view_versions","api_url":"/api","name":"Content view versions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_versions/index","name":"index","apis":[{"api_url":"/katello/api/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eFilter versions by environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_module_id","full_name":"puppet_module_id","description":"\n\u003cp\u003eFilter versions by puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eFilter versions by version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"composite_version_id","full_name":"composite_version_id","description":"\n\u003cp\u003eFilter versions that are components in the specified composite version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"triggered_by_id","full_name":"triggered_by_id","description":"\n\u003cp\u003eFilter composite versions whose publish was triggered by the specified\ncomponent version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"repository","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/show","name":"show","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"GET","short_description":"Show content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/promote","name":"promote","apis":[{"api_url":"/katello/api/content_view_versions/:id/promote","http_method":"POST","short_description":"Promote a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"\n\u003cp\u003eforce content view promotion and bypass lifecycle environment restriction\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eIdentifiers for Lifecycle Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version promotion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/update","name":"update","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"PUT","short_description":"Update a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/republish_repositories","name":"republish_repositories","apis":[{"api_url":"/katello/api/content_view_versions/:id/republish_repositories","http_method":"PUT","short_description":"Forces a republish of the version's repositories' metadata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/export_histories","name":"export_histories","apis":[{"api_url":"/katello/api/content_view_versions/export_histories","http_method":"GET","short_description":"Show the export history for a content view version","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":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"content_view_version_id","type":"integer"},{"name":"id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/export","name":"export","apis":[{"api_url":"/katello/api/content_view_versions/:id/export","http_method":"POST","short_description":"Export a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"destination_server","full_name":"destination_server","description":"\n\u003cp\u003eDestination Server name, required for Pulp3\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format. Relevant only for Pulp 2 repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB. Relevant only for Pulp 2 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":[]},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z). Relevant only for\nPulp 2 repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/import","name":"import","apis":[{"api_url":"/katello/api/content_view_versions/import","http_method":"POST","short_description":"Import a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"path","description":"\n\u003cp\u003eImport path\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"DELETE","short_description":"Remove content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/incremental_update","name":"incremental_update","apis":[{"api_url":"/katello/api/content_view_versions/incremental_update","http_method":"POST","short_description":"Perform an Incremental Update on one or more Content View Versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_environments","full_name":"content_view_version_environments","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_version_id","full_name":"content_view_version_environments[content_view_version_id]","description":"\n\u003cp\u003eContent View Version Ids to perform an incremental update on. May contain\ncomposites as well as one or more components to update.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"content_view_version_environments[environment_ids]","description":"\n\u003cp\u003eThe list of environments to promote the specified Content View Version to\n(replacing the older version)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the new generated Content View Versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resolve_dependencies","full_name":"resolve_dependencies","description":"\n\u003cp\u003eIf true, when adding the specified errata or packages, any needed\ndependencies will be copied as well. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"propagate_all_composites","full_name":"propagate_all_composites","description":"\n\u003cp\u003eIf true, will publish a new composite version using any specified\ncontent_view_version_id that has been promoted to a lifecycle environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"add_content","full_name":"add_content","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"errata_ids","full_name":"add_content[errata_ids]","description":"\n\u003cp\u003eErrata ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"package_ids","full_name":"add_content[package_ids]","description":"\n\u003cp\u003ePackage ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"deb_ids","full_name":"add_content[deb_ids]","description":"\n\u003cp\u003eDeb Package ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"puppet_module_ids","full_name":"add_content[puppet_module_ids]","description":"\n\u003cp\u003ePuppet Module ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"update_hosts","full_name":"update_hosts","description":"\n\u003cp\u003eAfter generating the incremental update, apply the changes to the specified\nhosts. Only Errata are supported currently.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"included","full_name":"update_hosts[included]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"update_hosts[included][search]","description":"\n\u003cp\u003eSearch string for host to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"update_hosts[included][ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"update_hosts[excluded]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"update_hosts[excluded][ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_views":{"doc_url":"../apidoc/v2/content_views","id":"content_views","api_url":"/api","name":"Content views","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_views/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"GET","short_description":"List content views","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"GET","short_description":"List content views","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"nondefault","full_name":"nondefault","description":"\n\u003cp\u003eFilter out default content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"noncomposite","full_name":"noncomposite","description":"\n\u003cp\u003eFilter out composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eFilter only composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"without","full_name":"without","description":"\n\u003cp\u003eDo not include this array of content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"composite","type":"boolean"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eContent view label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eComposite content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"PUT","short_description":"Update a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew name for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/publish","name":"publish","apis":[{"api_url":"/katello/api/content_views/:id/publish","http_method":"POST","short_description":"Publish a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the new published content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"major","description":"\n\u003cp\u003eOverride the major version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"minor","description":"\n\u003cp\u003eOverride the minor version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repos_units","full_name":"repos_units","description":"\n\u003cp\u003eSpecify the list of units in each repo\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"label","full_name":"repos_units[label]","description":"\n\u003cp\u003erepo label\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rpm_filenames","full_name":"repos_units[rpm_filenames]","description":"\n\u003cp\u003elist of rpm filename strings to include in published version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"GET","short_description":"Show a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_modules","name":"available_puppet_modules","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_modules","http_method":"GET","short_description":"Get puppet modules that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003emodule name to restrict modules for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_module_names","name":"available_puppet_module_names","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_module_names","http_method":"GET","short_description":"Get puppet modules names that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove_from_environment","name":"remove_from_environment","apis":[{"api_url":"/katello/api/content_views/:id/environments/:environment_id","http_method":"DELETE","short_description":"Remove a content view from an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove","name":"remove","apis":[{"api_url":"/katello/api/content_views/:id/remove","http_method":"PUT","short_description":"Remove versions and/or environments from a content view and reassign systems and keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eenvironment numeric identifiers to be removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view version identifiers to be deleted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"system_content_view_id","full_name":"system_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"system_environment_id","full_name":"system_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"key_content_view_id","full_name":"key_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"key_environment_id","full_name":"key_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"DELETE","short_description":"Delete a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/copy","name":"copy","apis":[{"api_url":"/katello/api/content_views/:id/copy","http_method":"POST","short_description":"Make copy of a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew content view name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"debs":{"doc_url":"../apidoc/v2/debs","id":"debs","api_url":"/api","name":"Deb Packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/debs/index","name":"index","apis":[{"api_url":"/katello/api/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs","http_method":"GET","short_description":"List debs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/debs/show","name":"show","apis":[{"api_url":"/katello/api/debs/:id","http_method":"GET","short_description":"Show a deb","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs/:id","http_method":"GET","short_description":"Show a deb","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea deb identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/debs/compare","name":"compare","apis":[{"api_url":"/katello/api/debs/compare","http_method":"GET","short_description":"List debs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"docker_manifest_lists":{"doc_url":"../apidoc/v2/docker_manifest_lists","id":"docker_manifest_lists","api_url":"/api","name":"Docker manifest lists","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifest_lists/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifest_lists/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest list identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifest_lists/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifest_lists/compare","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_manifests":{"doc_url":"../apidoc/v2/docker_manifests","id":"docker_manifests","api_url":"/api","name":"Docker manifests","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifests/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifests/compare","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_tags":{"doc_url":"../apidoc/v2/docker_tags","id":"docker_tags","api_url":"/api","name":"Docker tags","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_tags/index","name":"index","apis":[{"api_url":"/katello/api/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/show","name":"show","apis":[{"api_url":"/katello/api/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker tag identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_tags/compare","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/repositories","name":"repositories","apis":[{"api_url":"/katello/api/docker_tags/:id/repositories","http_method":"GET","short_description":"List of repositories for a docker meta tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"lifecycle_environments":{"doc_url":"../apidoc/v2/lifecycle_environments","id":"lifecycle_environments","api_url":"/api","name":"Lifecycle environments","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eAn environment is a basic organization structure that groups hosts,\nproducts, repositories, etc. Every host belongs to one environment and\nit\u0026#39;s isolated inside so that it can see only content that is in its\nenvironment.\u003c/p\u003e\n\n\u003cp\u003e## Chains\u003c/p\u003e\n\n\u003cp\u003eEnvironments are ordered into chains and their content (products,\nrepositories, tempaltes, packages) can be moved to an environment only from\nits prior environment. You can have for example chain like:\u003c/p\u003e\n\n\u003cpre\u003eLibrary -\u0026gt; Development -\u0026gt; Testing -\u0026gt; Production\u003c/pre\u003e\n\n\u003cp\u003eEach change in an environment is done through a changeset in an action\ncalled promotion.\u003c/p\u003e\n\n\u003cp\u003e## Library\u003c/p\u003e\n\n\u003cp\u003eLibrary is a special environment that has no ascendant: All the content\nstarts in this environment. More chains can start from the library\nenvironment but no further branching of a chain is enabled.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/lifecycle_environments/index","name":"index","apis":[{"api_url":"/katello/api/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"library","full_name":"library","description":"\n\u003cp\u003eset true if you want to see only library environments\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter only environments containing this name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/show","name":"show","apis":[{"api_url":"/katello/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/create","name":"create","apis":[{"api_url":"/katello/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"POST","short_description":"Create an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"prior_id","full_name":"prior_id","description":"\n\u003cp\u003eID of an environment that is prior to the new environment in the chain. It\nhas to be either the ID of Library or the ID of an environment at the end\nof a chain.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/update","name":"update","apis":[{"api_url":"/katello/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"PUT","short_description":"Update an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003enew name to be given to the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the update action to finish. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/destroy","name":"destroy","apis":[{"api_url":"/katello/api/environments/:id","http_method":"DELETE","short_description":"Destroy an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"DELETE","short_description":"Destroy an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/paths","name":"paths","apis":[{"api_url":"/katello/api/organizations/:organization_id/environments/paths","http_method":"GET","short_description":"List environment paths","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"permission_type","full_name":"permission_type","description":"\n\u003cp\u003eThe associated permission type. One of (readable | promotable) Default:\nreadable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"errata":{"doc_url":"../apidoc/v2/errata","id":"errata","api_url":"/api","name":"Errata","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/errata/index","name":"index","apis":[{"api_url":"/katello/api/errata","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn errata that can be added to the specified object. The values\n\u0026#39;content_view_version\u0026#39; and \u0026#39;content_view_filter are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"bug","type":"string"},{"name":"cve","type":"string"},{"name":"errata_id","type":"string"},{"name":"errata_type","type":"string"},{"name":"id","type":"string"},{"name":"issued","type":"date"},{"name":"modular","values":["true","false"]},{"name":"package","type":"string"},{"name":"package_name","type":"string"},{"name":"reboot_suggested","type":"boolean"},{"name":"repository","type":"string"},{"name":"severity","type":"string"},{"name":"title","type":"string"},{"name":"type","type":"string"},{"name":"updated","type":"date"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/show","name":"show","apis":[{"api_url":"/katello/api/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean erratum identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/compare","name":"compare","apis":[{"api_url":"/katello/api/errata/compare","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/available_errata","name":"available_errata","apis":[{"api_url":"/katello/api/content_view_versions/:id/available_errata","http_method":"GET","short_description":"Return errata that can be added to the Content View Version via an Incremental Update","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"file_units":{"doc_url":"../apidoc/v2/file_units","id":"file_units","api_url":"/api","name":"Files","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/file_units/index","name":"index","apis":[{"api_url":"/katello/api/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/file_units/show","name":"show","apis":[{"api_url":"/katello/api/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea file identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/file_units/compare","name":"compare","apis":[{"api_url":"/katello/api/files/compare","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"gpg_keys":{"doc_url":"../apidoc/v2/gpg_keys","id":"gpg_keys","api_url":"/api","name":"Gpg keys","short_description":null,"full_description":"\n\u003cp\u003e# Description Documents the calls for the list, read, create, update and\ndelete operations for GPG keys\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/gpg_keys/index","name":"index","apis":[{"api_url":"/katello/api/gpg_keys","http_method":"GET","short_description":"List gpg keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/create","name":"create","apis":[{"api_url":"/katello/api/gpg_keys","http_method":"POST","short_description":"Create a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the gpg key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/show","name":"show","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"GET","short_description":"Show a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/update","name":"update","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the gpg key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"DELETE","short_description":"Destroy a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/content","name":"content","apis":[{"api_url":"/katello/api/gpg_keys/:id/content","http_method":"GET","short_description":"Return the content of a gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/set_content","name":"set_content","apis":[{"api_url":"/katello/api/gpg_keys/:id/content","http_method":"POST","short_description":"Upload gpg key contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003efile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_collections":{"doc_url":"../apidoc/v2/host_collections","id":"host_collections","api_url":"/api","name":"Host collections","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_collections/show","name":"show","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"GET","short_description":"Show a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/index","name":"index","apis":[{"api_url":"/katello/api/host_collections","http_method":"GET","short_description":"List host collections","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"GET","short_description":"List host collections within an organization","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/host_collections","http_method":"GET","short_description":"List host collections in an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eactivation key identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eFilter products by host id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Host Collections that can be\nassociated with specified object. The value \u0026#39;host\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"host","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/create","name":"create","apis":[{"api_url":"/katello/api/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/update","name":"update","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"PUT","short_description":"Update a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/add_hosts","name":"add_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/add_hosts","http_method":"PUT","short_description":"Add host to the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/remove_hosts","name":"remove_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/remove_hosts","http_method":"PUT","short_description":"Remove hosts from the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/destroy","name":"destroy","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"DELETE","short_description":"Destroy a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/copy","name":"copy","apis":[{"api_url":"/katello/api/host_collections/:id/copy","http_method":"POST","short_description":"Make copy of a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew host collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_debs":{"doc_url":"../apidoc/v2/host_debs","id":"host_debs","api_url":"/api","name":"Host debs","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_debs/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/debs","http_method":"GET","short_description":"List deb packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_errata":{"doc_url":"../apidoc/v2/host_errata","id":"host_errata","api_url":"/api","name":"Host errata","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_errata/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/errata","http_method":"GET","short_description":"List errata available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Content View\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/apply","name":"apply","apis":[{"api_url":"/api/hosts/:host_id/errata/apply","http_method":"PUT","short_description":"Schedule errata for installation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids to install\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"\n\u003cp\u003eErrata to exclusively include in the action\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for erratum to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of errata ids to perform an action on, (ex: RHSA-2019:1168)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"\n\u003cp\u003eErrata to explicitly exclude in the action. All other applicable errata\nwill be included in the action, unless an included parameter is passed as\nwell.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of errata ids to exclude and not run an action on, (ex:\nRHSA-2019:1168)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/errata/:id","http_method":"GET","short_description":"Retrieve a single errata for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eErrata id of the erratum (RHSA-2012:108)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/applicability","name":"applicability","apis":[{"api_url":"/api/hosts/:host_id/errata/applicability","http_method":"PUT","short_description":"Force regenerate applicability.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_module_streams":{"doc_url":"../apidoc/v2/host_module_streams","id":"host_module_streams","api_url":"/api","name":"Host module streams","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_module_streams/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/module_streams","http_method":"GET","short_description":"List module streams available to the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eStreams based on the host based on their status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eenabled\u003c/code\u003e, \u003ccode\u003edisabled\u003c/code\u003e, \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003einstalled\u003c/code\u003e, \u003ccode\u003eupgradable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_packages":{"doc_url":"../apidoc/v2/host_packages","id":"host_packages","api_url":"/api","name":"Host packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_packages/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/packages","http_method":"GET","short_description":"List packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"arch","type":"string"},{"name":"epoch","type":"string"},{"name":"name","type":"string"},{"name":"nvra","type":"string"},{"name":"nvrea","type":"string"},{"name":"release","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/install","name":"install","apis":[{"api_url":"/api/hosts/:host_id/packages/install","http_method":"PUT","short_description":"Install packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade","name":"upgrade","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003elist of packages names\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade_all","name":"upgrade_all","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade_all","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/remove","name":"remove","apis":[{"api_url":"/api/hosts/:host_id/packages/remove","http_method":"PUT","short_description":"Uninstall packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_tracer":{"doc_url":"../apidoc/v2/host_tracer","id":"host_tracer","api_url":"/api","name":"Host tracer","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_tracer/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/traces","http_method":"GET","short_description":"List services that need restarting on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_tracer/resolve","name":"resolve","apis":[{"api_url":"/api/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":[]},{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"hosts_bulk_actions":{"doc_url":"../apidoc/v2/hosts_bulk_actions","id":"hosts_bulk_actions","api_url":"/api","name":"Hosts bulk actions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_add_host_collections","name":"bulk_add_host_collections","apis":[{"api_url":"/api/hosts/bulk/add_host_collections","http_method":"PUT","short_description":"Add one or more host collections to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_remove_host_collections","name":"bulk_remove_host_collections","apis":[{"api_url":"/api/hosts/bulk/remove_host_collections","http_method":"PUT","short_description":"Remove one or more host collections from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/applicable_errata","name":"applicable_errata","apis":[{"api_url":"/api/hosts/bulk/applicable_errata","http_method":"POST","short_description":"Fetch applicable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/installable_errata","name":"installable_errata","apis":[{"api_url":"/api/hosts/bulk/installable_errata","http_method":"POST","short_description":"Fetch installable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/install_content","name":"install_content","apis":[{"api_url":"/api/hosts/bulk/install_content","http_method":"PUT","short_description":"Install content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;,\n\u0026#39;package_group\u0026#39; and \u0026#39;errata\u0026#39;.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package names, package group names or errata ids)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/update_content","name":"update_content","apis":[{"api_url":"/api/hosts/bulk/update_content","http_method":"PUT","short_description":"Update content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;\nand \u0026#39;package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"update_all","full_name":"update_all","description":"\n\u003cp\u003eUpdates all packages on the host(s)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_content","name":"remove_content","apis":[{"api_url":"/api/hosts/bulk/remove_content","http_method":"PUT","short_description":"Remove content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;\nand \u0026#39;package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/destroy_hosts","name":"destroy_hosts","apis":[{"api_url":"/api/hosts/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/bulk/remove_subscriptions","http_method":"PUT","short_description":"Remove subscriptions from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of specified subscription to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/bulk/add_subscriptions","http_method":"PUT","short_description":"Add subscriptions to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/bulk/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/content_overrides","name":"content_overrides","apis":[{"api_url":"/api/hosts/bulk/content_overrides","http_method":"PUT","short_description":"Set content overrides to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be\n\u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/environment_content_view","name":"environment_content_view","apis":[{"api_url":"/api/hosts/bulk/environment_content_view","http_method":"PUT","short_description":"Assign the environment and content view to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/release_version","name":"release_version","apis":[{"api_url":"/api/hosts/bulk/release_version","http_method":"PUT","short_description":"Assign the release version to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/traces","name":"traces","apis":[{"api_url":"/api/hosts/bulk/traces","http_method":"POST","short_description":"Fetch traces for one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/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":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/available_incremental_updates","name":"available_incremental_updates","apis":[{"api_url":"/api/hosts/bulk/available_incremental_updates","http_method":"POST","short_description":"Given a set of hosts and errata, lists the content view versions and environments that need updating.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/module_streams","name":"module_streams","apis":[{"api_url":"/api/hosts/bulk/module_streams","http_method":"POST","short_description":"Fetch available module streams for hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"module_streams":{"doc_url":"../apidoc/v2/module_streams","id":"module_streams","api_url":"/api","name":"Module streams","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/module_streams/index","name":"index","apis":[{"api_url":"/katello/api/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host id to list available module streams for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"name_stream_only","full_name":"name_stream_only","description":"\n\u003cp\u003eReturn name and stream information only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/module_streams/show","name":"show","apis":[{"api_url":"/katello/api/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea module stream identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/module_streams/compare","name":"compare","apis":[{"api_url":"/katello/api/module_streams/compare","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ostree_branches":{"doc_url":"../apidoc/v2/ostree_branches","id":"ostree_branches","api_url":"/api","name":"Ostree branches","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ostree_branches/index","name":"index","apis":[{"api_url":"/katello/api/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ostree_branches/show","name":"show","apis":[{"api_url":"/katello/api/ostree_branches/:id","http_method":"GET","short_description":"Show an ostree branch","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_branches/:id","http_method":"GET","short_description":"Show an ostree branch","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ostree branch identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ostree_branches/compare","name":"compare","apis":[{"api_url":"/katello/api/ostree_branches/compare","http_method":"GET","short_description":"List ostree_branches","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repository_sets":{"doc_url":"../apidoc/v2/repository_sets","id":"repository_sets","api_url":"/api","name":"Repository sets","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repository_sets/index","name":"index","apis":[{"api_url":"/katello/api/repository_sets","http_method":"GET","short_description":"List repository sets.","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets","http_method":"GET","short_description":"List repository sets for a product.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eRepository set name to search on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eIf true, only return repository sets that have been enabled. Defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"with_active_subscription","full_name":"with_active_subscription","description":"\n\u003cp\u003eIf true, only return repository sets that are associated with an active\nsubscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"with_custom","full_name":"with_custom","description":"\n\u003cp\u003eIf true, return custom repository sets along with redhat repos\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/show","name":"show","apis":[{"api_url":"/katello/api/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/available_repositories","name":"available_repositories","apis":[{"api_url":"/katello/api/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/enable","name":"enable","apis":[{"api_url":"/katello/api/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to enable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/disable","name":"disable","apis":[{"api_url":"/katello/api/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to disable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"srpms":{"doc_url":"../apidoc/v2/srpms","id":"srpms","api_url":"/api","name":"Srpms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/srpms/index","name":"index","apis":[{"api_url":"/katello/api/srpms","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/srpms/show","name":"show","apis":[{"api_url":"/katello/api/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSRPM details identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/srpms/compare","name":"compare","apis":[{"api_url":"/katello/api/srpms/compare","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subscriptions":{"doc_url":"../apidoc/v2/subscriptions","id":"subscriptions","api_url":"/api","name":"Subscriptions","short_description":null,"full_description":"\n\u003cp\u003eSubscriptions management.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions","http_method":"GET","short_description":"List organization subscriptions","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/subscriptions","http_method":"GET","short_description":"List an activation key's subscriptions","deprecated":null},{"api_url":"/katello/api/subscriptions","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of a host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eActivation key ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eObject to show subscriptions available for, either \u0026#39;host\u0026#39; or\n\u0026#39;activation_key\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"match_host","full_name":"match_host","description":"\n\u003cp\u003eIgnore subscriptions that are unavailable to the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"match_installed","full_name":"match_installed","description":"\n\u003cp\u003eReturn subscriptions that match installed products of the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"no_overlap","full_name":"no_overlap","description":"\n\u003cp\u003eReturn subscriptions which do not overlap with a currently-attached\nsubscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null},{"api_url":"/katello/api/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/upload","name":"upload","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eSubscription manifest file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]},{"name":"repository_url","full_name":"repository_url","description":"\n\u003cp\u003erepository url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/refresh_manifest","name":"refresh_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/refresh_manifest","http_method":"PUT","short_description":"Refresh previously imported manifest for Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/delete_manifest","name":"delete_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/delete_manifest","http_method":"POST","short_description":"Delete manifest from Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/manifest_history","name":"manifest_history","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/manifest_history","http_method":"GET","short_description":"obtain manifest history for subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}},"link_extension":".html"}} \ No newline at end of file diff --git a/tests/test_playbooks/content_views_role.yml b/tests/test_playbooks/content_views_role.yml new file mode 100644 index 00000000..23b542bf --- /dev/null +++ b/tests/test_playbooks/content_views_role.yml @@ -0,0 +1,68 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: ensure test organization + include_tasks: tasks/organization.yml + vars: + organization_name: "Test Organization" + organization_state: "present" + - include: tasks/product.yml + vars: + product_state: present + - include: tasks/repository.yml + vars: + repository_state: present + - include: tasks/content_view.yml + vars: + content_view_name: "Test Composite Content View" + content_view_state: absent + - include: tasks/content_view.yml + vars: + content_view_state: absent + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + roles: + - role: content_views + vars: + foreman_organization: "Test Organization" + foreman_content_views: + - name: "Test Content View" + repositories: + - name: "Test Repository" + product: "Test Product" + - name: "Test Composite Content View" + components: + - content_view: Test Content View + latest: true + - name: "Test Content View with Filter" + repositories: + - name: "Test Repository" + product: "Test Product" + filters: + - name: "Test Package Content View Filter" + filter_state: "present" + filter_type: "rpm" + rule_name: "bear" + +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: ensure test organization + include_tasks: tasks/organization.yml + vars: + organization_name: "Test Organization" + organization_state: "absent" diff --git a/tests/test_playbooks/fixtures/content_views_role-0.yml b/tests/test_playbooks/fixtures/content_views_role-0.yml new file mode 100644 index 00000000..ed592420 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_views_role-0.yml @@ -0,0 +1,368 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.0","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-04-23 11:43:51 UTC\",\"updated_at\"\ + :\"2021-04-23 11:43:51 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\"\ + :\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + response: + body: + string: '{"total":1,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 5; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '157' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + response: + body: + string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":3,"cp_id":"31834253451","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2021-04-23 + 11:43:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":1}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 5; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '648' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/3/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + response: + body: + string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"6ba86b50-7879-46be-91f0-0ca39bec7654","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://localhost/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/8948f76b-34fc-4982-8181-1d32d5c90b8d/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/01af8bde-43f9-4ba9-bf92-66303a6f033a/","id":3,"name":"Test + Repository","label":"Test_Repository","description":null,"last_sync":null,"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":4,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":null,"arch":"noarch","os_versions":[],"content_id":"1619178237889","major":null,"minor":null,"product":{"id":3,"cp_id":"31834253451","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","content_counts":{"ostree_branch":0,"docker_manifest":0,"docker_manifest_list":0,"docker_tag":0,"rpm":0,"srpm":0,"package":0,"package_group":0,"erratum":0,"puppet_module":0,"file":0,"deb":0,"module_stream":0,"ansible_collection":0},"last_sync_words":null}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1515' + status: + code: 200 + message: OK +- request: + body: '{"name": "Test Content View", "composite": false, "repository_ids": [3], + "auto_publish": false}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '95' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/organizations/5/content_views + response: + body: + string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 + 11:44:01 UTC","updated_at":"2021-04-23 11:44:01 UTC","environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true},"duplicate_repositories_to_publish":[],"errors":null} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 5; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/test_playbooks/fixtures/content_views_role-1.yml b/tests/test_playbooks/fixtures/content_views_role-1.yml new file mode 100644 index 00000000..2e48fa12 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_views_role-1.yml @@ -0,0 +1,432 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.0","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-04-23 11:43:51 UTC\",\"updated_at\"\ + :\"2021-04-23 11:43:51 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\"\ + :\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Composite+Content+View%22&per_page=4294967296 + response: + body: + string: '{"total":2,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Composite Content View\"","sort":{"by":"name","order":"asc"},"results":[]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 5; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '167' + status: + code: 200 + message: OK +- request: + body: '{"name": "Test Composite Content View", "composite": true, "auto_publish": + false}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '81' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/organizations/5/content_views + response: + body: + string: ' {"content_host_count":0,"composite":true,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[],"id":11,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 + 11:44:01 UTC","updated_at":"2021-04-23 11:44:01 UTC","environments":[],"repositories":[],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true},"duplicate_repositories_to_publish":[],"errors":null} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 5; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View%22&per_page=4294967296 + response: + body: + string: '{"total":3,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Content View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 + 11:44:01 UTC","updated_at":"2021-04-23 11:44:01 UTC","environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 5; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1056' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_views/10 + response: + body: + string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 + 11:44:01 UTC","updated_at":"2021-04-23 11:44:01 UTC","environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true},"duplicate_repositories_to_publish":[],"errors":null} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '978' + status: + code: 200 + message: OK +- request: + body: '{"components": [{"latest": true, "content_view_id": 10}]}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '57' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: PUT + uri: https://foreman.example.org/katello/api/content_views/11/content_view_components/add + response: + body: + string: '{"total":1,"subtotal":1,"page":null,"per_page":null,"error":null,"search":null,"sort":{"by":null,"order":null},"results":[{"latest":true,"id":3,"created_at":"2021-04-23 + 11:44:01 UTC","updated_at":"2021-04-23 11:44:01 UTC","composite_content_view":{"id":11,"name":"Test + Composite Content View","label":"Test_Composite_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view":{"id":10,"name":"Test + Content View","label":"Test_Content_View","description":null,"next_version":1,"latest_version":null,"version_count":0},"content_view_version":null}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=94 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '595' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/content_views_role-2.yml b/tests/test_playbooks/fixtures/content_views_role-2.yml new file mode 100644 index 00000000..666aea59 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_views_role-2.yml @@ -0,0 +1,368 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.0","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-04-23 11:43:51 UTC\",\"updated_at\"\ + :\"2021-04-23 11:43:51 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\"\ + :\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 + response: + body: + string: '{"total":3,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Content View with Filter\"","sort":{"by":"name","order":"asc"},"results":[]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 5; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '169' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/5/products?search=name%3D%22Test+Product%22&per_page=4294967296 + response: + body: + string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":3,"cp_id":"31834253451","name":"Test + Product","label":"Test_Product","description":"A happy little test product","provider_id":7,"sync_plan_id":null,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2021-04-23 + 11:43:59 UTC","last_sync_words":"less than a minute","organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"sync_plan":null,"repository_count":1}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 5; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '648' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/3/repositories?search=name%3D%22Test+Repository%22&per_page=4294967296 + response: + body: + string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Repository\"","sort":{"by":"name","order":"asc"},"results":[{"backend_identifier":"6ba86b50-7879-46be-91f0-0ca39bec7654","relative_path":"Test_Organization/Library/custom/Test_Product/Test_Repository","container_repository_name":null,"full_path":"https://localhost/pulp/content/Test_Organization/Library/custom/Test_Product/Test_Repository/","library_instance_id":null,"version_href":"/pulp/api/v3/repositories/rpm/rpm/8948f76b-34fc-4982-8181-1d32d5c90b8d/versions/0/","remote_href":null,"publication_href":"/pulp/api/v3/publications/rpm/rpm/01af8bde-43f9-4ba9-bf92-66303a6f033a/","id":3,"name":"Test + Repository","label":"Test_Repository","description":null,"last_sync":null,"content_view":{"id":9,"name":"Default + Organization View"},"content_view_version":{"id":4,"name":"Default Organization + View 1.0","content_view_id":9},"kt_environment":{"id":4,"name":"Library"},"content_type":"yum","url":null,"arch":"noarch","os_versions":[],"content_id":"1619178237889","major":null,"minor":null,"product":{"id":3,"cp_id":"31834253451","name":"Test + Product","orphaned":false,"redhat":false,"sync_plan":null},"content_label":"Test_Organization_Test_Product_Test_Repository","content_counts":{"ostree_branch":0,"docker_manifest":0,"docker_manifest_list":0,"docker_tag":0,"rpm":0,"srpm":0,"package":0,"package_group":0,"erratum":0,"puppet_module":0,"file":0,"deb":0,"module_stream":0,"ansible_collection":0},"last_sync_words":null}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1515' + status: + code: 200 + message: OK +- request: + body: '{"name": "Test Content View with Filter", "composite": false, "repository_ids": + [3], "auto_publish": false}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '107' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/organizations/5/content_views + response: + body: + string: ' {"content_host_count":0,"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":12,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 + 11:44:02 UTC","updated_at":"2021-04-23 11:44:02 UTC","environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true},"duplicate_repositories_to_publish":[],"errors":null} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 5; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 diff --git a/tests/test_playbooks/fixtures/content_views_role-3.yml b/tests/test_playbooks/fixtures/content_views_role-3.yml new file mode 100644 index 00000000..4bf113e6 --- /dev/null +++ b/tests/test_playbooks/fixtures/content_views_role-3.yml @@ -0,0 +1,370 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.0","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-04-23 11:43:51 UTC\",\"updated_at\"\ + :\"2021-04-23 11:43:51 UTC\",\"id\":5,\"name\":\"Test Organization\",\"title\"\ + :\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/5/content_views?search=name%3D%22Test+Content+View+with+Filter%22&per_page=4294967296 + response: + body: + string: '{"total":4,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Content View with Filter\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":12,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 + 11:44:02 UTC","updated_at":"2021-04-23 11:44:02 UTC","environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum"}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 5; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1092' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/content_views/12/filters?search=name%3D%22Test+Package+Content+View+Filter%22&per_page=4294967296 + response: + body: + string: '{"total":0,"subtotal":0,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Package Content View Filter\"","sort":{"by":"name","order":"asc"},"results":[]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '172' + status: + code: 200 + message: OK +- request: + body: '{"name": "Test Package Content View Filter", "type": "rpm", "inclusion": + false, "repository_ids": []}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '101' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/content_views/12/filters + response: + body: + string: ' {"inclusion":false,"original_packages":false,"id":2,"name":"Test + Package Content View Filter","description":null,"created_at":"2021-04-23 11:44:03 + UTC","updated_at":"2021-04-23 11:44:03 UTC","content_view":{"composite":false,"component_ids":[],"default":false,"force_puppet_environment":false,"version_count":0,"latest_version":null,"auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[3],"id":12,"name":"Test + Content View with Filter","label":"Test_Content_View_with_Filter","description":null,"organization_id":5,"organization":{"name":"Test + Organization","label":"Test_Organization","id":5},"created_at":"2021-04-23 + 11:44:02 UTC","updated_at":"2021-04-23 11:44:02 UTC","environments":[],"repositories":[{"id":3,"name":"Test + Repository","label":"Test_Repository","content_type":"yum","product":{"id":3,"name":"Test + Product"},"content_counts":{"ostree_branch":0,"docker_manifest":0,"docker_tag":0,"rpm":0,"package":0,"package_group":0,"erratum":0,"puppet_module":0,"module_stream":0}}],"puppet_modules":[],"versions":[],"components":[],"content_view_components":[],"activation_keys":[],"next_version":"1.0","last_published":null,"permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true}},"repositories":[],"type":"rpm","rules":[]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +- request: + body: '{"name": "bear"}' + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '16' + Content-Type: + - application/json + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: POST + uri: https://foreman.example.org/katello/api/content_view_filters/2/rules + response: + body: + string: ' {"content_view_filter_id":2,"id":2,"name":"bear","created_at":"2021-04-23 + 11:44:03 UTC","updated_at":"2021-04-23 11:44:03 UTC"} + + ' + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Transfer-Encoding: + - chunked + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + status: + code: 201 + message: Created +version: 1 From f4ab021e9bdf704a85a898f47853e488405b2a0e Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Fri, 23 Apr 2021 14:22:12 +0200 Subject: [PATCH 43/56] add changelog --- changelogs/fragments/1111-content_views_role.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelogs/fragments/1111-content_views_role.yml diff --git a/changelogs/fragments/1111-content_views_role.yml b/changelogs/fragments/1111-content_views_role.yml new file mode 100644 index 00000000..6d316918 --- /dev/null +++ b/changelogs/fragments/1111-content_views_role.yml @@ -0,0 +1,2 @@ +minor_changes: + - new ``content_views`` role to manage content views (https://github.com/theforeman/foreman-ansible-modules/issues/1111) From 4587af04d04a56566cac8ab1a36f5b788647a341 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Mon, 3 May 2021 11:23:42 +0200 Subject: [PATCH 44/56] Add Redfish to list of possible BMC providers of an interface --- changelogs/fragments/host-redfish-bmc.yml | 2 ++ plugins/module_utils/foreman_helper.py | 2 +- plugins/modules/host.py | 1 + 3 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 changelogs/fragments/host-redfish-bmc.yml diff --git a/changelogs/fragments/host-redfish-bmc.yml b/changelogs/fragments/host-redfish-bmc.yml new file mode 100644 index 00000000..91a81812 --- /dev/null +++ b/changelogs/fragments/host-redfish-bmc.yml @@ -0,0 +1,2 @@ +minor_changes: + - host - Add ``Redfish`` to list of possible BMC providers of an interface diff --git a/plugins/module_utils/foreman_helper.py b/plugins/module_utils/foreman_helper.py index 432c76df..e8333567 100644 --- a/plugins/module_utils/foreman_helper.py +++ b/plugins/module_utils/foreman_helper.py @@ -1834,7 +1834,7 @@ def ensure_puppetclasses(module, entity_type, entity, expected_puppetclasses=Non provision=dict(type='bool'), username=dict(), password=dict(no_log=True), - provider=dict(choices=['IPMI', 'SSH']), + provider=dict(choices=['IPMI', 'Redfish', 'SSH']), virtual=dict(type='bool'), tag=dict(), mtu=dict(type='int'), diff --git a/plugins/modules/host.py b/plugins/modules/host.py index c4d14de0..d2e1e7fb 100644 --- a/plugins/modules/host.py +++ b/plugins/modules/host.py @@ -204,6 +204,7 @@ type: str choices: - 'IPMI' + - 'Redfish' - 'SSH' virtual: description: From c1ea1a58c03985e0998c86eb6792e2bd74e520ea Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Mon, 3 May 2021 11:38:52 +0200 Subject: [PATCH 45/56] use foreman prefixed vars in cvmanager migration docs --- docs/cvmanager.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/cvmanager.md b/docs/cvmanager.md index 48430e70..f09c684a 100644 --- a/docs/cvmanager.md +++ b/docs/cvmanager.md @@ -15,11 +15,11 @@ To ease cleanup of old Content Views, we ship the `content_view_version_cleanup` roles: - role: theforeman.foreman.content_view_version_cleanup vars: - server_url: https://foreman.example.com - username: "admin" - password: "changeme" - organization: "Default Organization" - content_view_version_cleanup_keep: 10 + foreman_server_url: https://foreman.example.com + foreman_username: "admin" + foreman_password: "changeme" + foreman_organization: "Default Organization" + foreman_content_view_version_cleanup_keep: 10 ``` ## Automated Updates From 094750de5741593f3b77f28b7c94847c1d2123fc Mon Sep 17 00:00:00 2001 From: yifatmakias Date: Sun, 4 Apr 2021 16:43:02 +0300 Subject: [PATCH 46/56] Fixes #32124 - add check mode detail to callback report --- plugins/callback/foreman.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/plugins/callback/foreman.py b/plugins/callback/foreman.py index 6f41b10f..647dba07 100644 --- a/plugins/callback/foreman.py +++ b/plugins/callback/foreman.py @@ -246,8 +246,12 @@ def send_reports(self, stats): }, "logs": list(build_log(self.items[host])), "reporter": "ansible", + "check_mode": self.check_mode, } } + if self.check_mode: + report['config_report']['status']['pending'] = total['changed'] + report['config_report']['status']['applied'] = 0 try: response = self.session.post(url=url, json=report) response.raise_for_status() @@ -263,6 +267,7 @@ def append_result(self, result, failed=False): value = result._result value['failed'] = failed self.items[host].append((name, value)) + self.check_mode = result._task.check_mode if 'ansible_facts' in value: self.facts[host].update(value['ansible_facts']) From 43393411951275a5d749292f3584b884b997f034 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Mon, 3 May 2021 14:45:26 +0200 Subject: [PATCH 47/56] fix formating of image example --- plugins/modules/image.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/plugins/modules/image.py b/plugins/modules/image.py index 1c08f926..cb572d4a 100644 --- a/plugins/modules/image.py +++ b/plugins/modules/image.py @@ -68,14 +68,14 @@ ''' EXAMPLES = ''' - - name: create Image for EC2 - image: - name: CentOS - image_uuid: "ami-0ff760d16d9497662" - image_username: "centos" - operatingsystem: "CentOS 7" - compute_resource: "AWS" - architecture: "x86_64" +- name: create Image for EC2 + image: + name: CentOS + image_uuid: "ami-0ff760d16d9497662" + image_username: "centos" + operatingsystem: "CentOS 7" + compute_resource: "AWS" + architecture: "x86_64" ''' RETURN = ''' From c7c1de3b0b4a164d5c8f69acce9cb3f90a746bee Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Mon, 3 May 2021 20:35:29 +0200 Subject: [PATCH 48/56] pass the UUID of an image to the compute resource when creating a host Yes, the field in the compute attributes is really called `image_id`. Yes, it really expects the *UUID* of the image there. Fixes: #1160 --- .../fragments/1160-pass-image-in-compute-attributes.yml | 2 ++ plugins/modules/host.py | 5 +++++ 2 files changed, 7 insertions(+) create mode 100644 changelogs/fragments/1160-pass-image-in-compute-attributes.yml diff --git a/changelogs/fragments/1160-pass-image-in-compute-attributes.yml b/changelogs/fragments/1160-pass-image-in-compute-attributes.yml new file mode 100644 index 00000000..98441ac3 --- /dev/null +++ b/changelogs/fragments/1160-pass-image-in-compute-attributes.yml @@ -0,0 +1,2 @@ +bugfixes: + - host - pass the right image id to the compute resource when creating a host (https://github.com/theforeman/foreman-ansible-modules/issues/1160, https://bugzilla.redhat.com/show_bug.cgi?id=1911670) diff --git a/plugins/modules/host.py b/plugins/modules/host.py index d2e1e7fb..e37357c0 100644 --- a/plugins/modules/host.py +++ b/plugins/modules/host.py @@ -484,6 +484,11 @@ def main(): if not module.desired_absent: module.auto_lookup_entities() + if 'image' in module.foreman_params: + if 'compute_attributes' not in module.foreman_params: + module.foreman_params['compute_attributes'] = {} + module.foreman_params['compute_attributes']['image_id'] = module.foreman_params['image']['uuid'] + if 'compute_resource' in module.foreman_params: compute_resource = module.foreman_params['compute_resource'] cluster = None From 4e8b826ef298810d80d90de304852a953d9f7dc4 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Fri, 7 May 2021 07:55:50 +0200 Subject: [PATCH 49/56] add cloud param for the AzureRm provider --- changelogs/fragments/azure-clouds.yml | 2 ++ plugins/modules/compute_resource.py | 14 +++++++++++++- 2 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 changelogs/fragments/azure-clouds.yml diff --git a/changelogs/fragments/azure-clouds.yml b/changelogs/fragments/azure-clouds.yml new file mode 100644 index 00000000..2595f82f --- /dev/null +++ b/changelogs/fragments/azure-clouds.yml @@ -0,0 +1,2 @@ +minor_changes: + - compute_resource - add ``cloud`` param for the AzureRm provider, to select which Azure cloud to use diff --git a/plugins/modules/compute_resource.py b/plugins/modules/compute_resource.py index 8a121622..8c0a054e 100644 --- a/plugins/modules/compute_resource.py +++ b/plugins/modules/compute_resource.py @@ -112,6 +112,16 @@ description: - zone for I(provider=GCE) type: str + cloud: + description: + - cloud for I(provider=AzureRm) + type: str + choices: + - azure + - azureusgovernment + - azurechina + - azuregermancloud + version_added: 2.1.0 ssl_verify_peer: description: - verify ssl from provider I(provider=proxmox) @@ -368,7 +378,7 @@ def get_provider_info(provider): return 'EC2', ['user', 'password', 'region'] elif provider_name == 'azurerm': - return 'AzureRm', ['user', 'password', 'tenant', 'region', 'app_ident'] + return 'AzureRm', ['user', 'password', 'tenant', 'region', 'app_ident', 'cloud'] elif provider_name == 'gce': return 'GCE', ['project', 'email', 'key_path', 'zone'] @@ -403,6 +413,7 @@ def main(): email=dict(invisible=True), key_path=dict(invisible=True), zone=dict(invisible=True), + cloud=dict(invisible=True), ssl_verify_peer=dict(invisible=True), set_console_password=dict(invisible=True), keyboard_layout=dict(invisible=True), @@ -425,6 +436,7 @@ def main(): email=dict(), key_path=dict(no_log=False), zone=dict(), + cloud=dict(choices=['azure', 'azureusgovernment', 'azurechina', 'azuregermancloud']), ssl_verify_peer=dict(type='bool'), set_console_password=dict(type='bool'), keyboard_layout=dict(choices=['ar', 'de-ch', 'es', 'fo', 'fr-ca', 'hu', 'ja', 'mk', 'no', 'pt-br', 'sv', 'da', 'en-gb', 'et', 'fr', 'fr-ch', From 292dc967ee203660c4628cfcf3edf12fc0278590 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Mon, 10 May 2021 15:36:44 +0200 Subject: [PATCH 50/56] make fixtures links, not blobs seems we accidentally commited two full apidocs instead of links --- tests/fixtures/apidoc/content_views_role.json | 2 +- tests/fixtures/apidoc/organizations_role.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) mode change 100644 => 120000 tests/fixtures/apidoc/content_views_role.json mode change 100644 => 120000 tests/fixtures/apidoc/organizations_role.json diff --git a/tests/fixtures/apidoc/content_views_role.json b/tests/fixtures/apidoc/content_views_role.json deleted file mode 100644 index 92535092..00000000 --- a/tests/fixtures/apidoc/content_views_role.json +++ /dev/null @@ -1 +0,0 @@ -{"docs":{"name":"Foreman","info":"\n\u003cp\u003eForeman API v2 is currently the default API version.\u003c/p\u003e\n","copyright":"","doc_url":"../apidoc/v2","api_url":"/api","resources":{"host_subscriptions":{"doc_url":"../apidoc/v2/host_subscriptions","id":"host_subscriptions","api_url":"/api","name":"Host subscriptions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_subscriptions/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"GET","short_description":"List a host's subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/subscriptions","http_method":"DELETE","short_description":"Unregister the host as a subscription consumer","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/create","name":"create","apis":[{"api_url":"/api/hosts/subscriptions","http_method":"POST","short_description":"Register a host with subscription and information","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003eUUID to use for registered host, random uuid is generated if not provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003eKey-value hash of subscription-manager facts, nesting uses a period\ndelimiter (.)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"hypervisor_guest_uuids","description":"\n\u003cp\u003eUUIDs of the virtual guests from the host\u0026#39;s hypervisor\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products","full_name":"installed_products","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"installed_products[product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"installed_products[product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"installed_products[arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"installed_products[version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003eRelease version of the content host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eA service level for auto-healing process, e.g. SELF-SUPPORT\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"lifecycle_environment_id","description":"\n\u003cp\u003eLifecycle Environment ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent View ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/remove_subscriptions","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eIf specified, remove the first instance of a subscription with matching id\nand quantity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/add_subscriptions","http_method":"PUT","short_description":"Add a subscription to a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/content_override","name":"content_override","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/content_override","http_method":"PUT","short_description":"Set content overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"value","description":"\n\u003cp\u003eOverride to a boolean value or \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be\n\u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/product_content","name":"product_content","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/product_content","http_method":"GET","short_description":"Get content and overrides for the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eId of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the host\u0026#39;s content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_subscriptions/available_release_versions","name":"available_release_versions","apis":[{"api_url":"/api/hosts/:host_id/subscriptions/available_release_versions","http_method":"GET","short_description":"Show releases available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"interfaces":{"doc_url":"../apidoc/v2/interfaces","id":"interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"GET","short_description":"Show an interface for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subnets":{"doc_url":"../apidoc/v2/subnets","id":"subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/create","name":"create","apis":[{"api_url":"/api/subnets","http_method":"POST","short_description":"Create a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"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":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hosts":{"doc_url":"../apidoc/v2/hosts","id":"hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null},{"api_url":"/api/environments/:environment_id/hosts","http_method":"GET","short_description":"List hosts per environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"activation_key","type":"string"},{"name":"activation_key_id","type":"string"},{"name":"addon","type":"string"},{"name":"addons_status","values":["mismatched","matched","not_specified"]},{"name":"applicable_errata","type":"string"},{"name":"applicable_errata_issued","type":"date"},{"name":"applicable_rpms","type":"string"},{"name":"architecture","type":"string"},{"name":"autoheal","type":"boolean"},{"name":"available_module_stream_name","type":"string"},{"name":"available_module_stream_stream","type":"string"},{"name":"boot_time","type":""},{"name":"build","values":["true","false"]},{"name":"class","type":"string"},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"config_group","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"created_at","type":"datetime"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"environment","type":"string"},{"name":"errata_status","values":["security_needed","errata_needed","updated","unknown"]},{"name":"execution_status","values":["ok","error"]},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","type":"string"},{"name":"has_mac","type":"string"},{"name":"host_collection","type":"string"},{"name":"host_collection_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_id","type":"integer"},{"name":"hostgroup_name","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"hypervisor","type":"boolean"},{"name":"hypervisor_host","type":"string"},{"name":"image","type":"string"},{"name":"installable_errata","type":"string"},{"name":"installed_at","type":"datetime"},{"name":"installed_package","type":"string"},{"name":"installed_package_name","type":"string"},{"name":"ip","type":"string"},{"name":"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_environment","type":"string"},{"name":"lifecycle_environment_id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mac","type":"string"},{"name":"managed","values":["true","false"]},{"name":"model","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"origin","type":"string"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"owner","type":"string"},{"name":"owner_id","type":"integer"},{"name":"owner_type","type":"string"},{"name":"params","type":"string"},{"name":"params_name","type":"string"},{"name":"parent_hostgroup","type":"string"},{"name":"pools_expiring_in_days","type":"string"},{"name":"puppet_ca","type":"string"},{"name":"puppet_proxy_id","type":"integer"},{"name":"puppetmaster","type":"string"},{"name":"purpose_status","values":["mismatched","matched","not_specified"]},{"name":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"name":"registered_at","type":"datetime"},{"name":"registered_through","type":"string"},{"name":"release_version","type":"string"},{"name":"role","type":"text"},{"name":"role_status","values":["mismatched","matched","not_specified"]},{"name":"service_level","type":"string"},{"name":"sla_status","values":["mismatched","matched","not_specified"]},{"name":"smart_proxy","type":"string"},{"name":"status.applied","type":"integer"},{"name":"status.enabled","values":["true","false"]},{"name":"status.failed","type":"integer"},{"name":"status.failed_restarts","type":"integer"},{"name":"status.interesting","values":["true","false"]},{"name":"status.pending","type":"integer"},{"name":"status.restarted","type":"integer"},{"name":"status.skipped","type":"integer"},{"name":"subnet","type":"string"},{"name":"subnet.name","type":"text"},{"name":"subnet6","type":"string"},{"name":"subnet6.name","type":"text"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"subscription_status","values":["valid","partial","invalid","unknown","disabled","unsubscribed_hypervisor"]},{"name":"subscription_uuid","type":"string"},{"name":"trace_app","type":"string"},{"name":"trace_app_type","type":"string"},{"name":"trace_helper","type":"string"},{"name":"trace_status","values":["reboot_needed","process_restart_needed","updated"]},{"name":"upgradable_rpms","type":"string"},{"name":"usage","type":"text"},{"name":"usage_status","values":["mismatched","matched","not_specified"]},{"name":"user.firstname","type":"string"},{"name":"user.lastname","type":"string"},{"name":"user.login","type":"string"},{"name":"user.mail","type":"string"},{"name":"usergroup","type":"string"},{"name":"usergroup.name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/show","name":"show","apis":[{"api_url":"/api/hosts/:id","http_method":"GET","short_description":"Show a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"content_facet_attributes","full_name":"host[content_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s content_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_id","full_name":"host[content_facet_attributes][content_view_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"host[content_facet_attributes][lifecycle_environment_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"host[content_facet_attributes][content_source_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"host[content_facet_attributes][kickstart_repository_id]","description":"\n\u003cp\u003eRepository Id associated with the kickstart repo used for provisioning\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"subscription_facet_attributes","full_name":"host[subscription_facet_attributes]","description":"\n\u003cp\u003eParameters for host\u0026#39;s subscription_facet facet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"release_version","full_name":"host[subscription_facet_attributes][release_version]","description":"\n\u003cp\u003eRelease version for this Host to use (7Server, 7.1, etc)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"autoheal","full_name":"host[subscription_facet_attributes][autoheal]","description":"\n\u003cp\u003eSets whether the Host will autoheal subscriptions upon checkin\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"host[subscription_facet_attributes][purpose_usage]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"host[subscription_facet_attributes][purpose_role]","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"host[subscription_facet_attributes][purpose_addons]","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"host[subscription_facet_attributes][service_level]","description":"\n\u003cp\u003eService level to be used for autoheal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hypervisor_guest_uuids","full_name":"host[subscription_facet_attributes][hypervisor_guest_uuids]","description":"\n\u003cp\u003eList of hypervisor guest uuids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"installed_products_attributes","full_name":"host[subscription_facet_attributes][installed_products_attributes]","description":"\n\u003cp\u003eList of products installed on the host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"product_id","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_id]","description":"\n\u003cp\u003eProduct id as listed from a host\u0026#39;s installed products, this is\nnot the same product id as the products api returns\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_name","full_name":"host[subscription_facet_attributes][installed_products_attributes][product_name]","description":"\n\u003cp\u003eProduct name as listed from a host\u0026#39;s installed products\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arch","full_name":"host[subscription_facet_attributes][installed_products_attributes][arch]","description":"\n\u003cp\u003eProduct architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"host[subscription_facet_attributes][installed_products_attributes][version]","description":"\n\u003cp\u003eProduct version\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/enc","name":"enc","apis":[{"api_url":"/api/hosts/:id/enc","http_method":"GET","short_description":"Get ENC values of host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eglobal\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003econfiguration\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ebuild\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host\u0026#39;s compute attributes that can be used to create a clone\nof this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot),\n(cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host,\nContent_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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE,\nprovision, finish, script, user_data, ZTP, POAP, cloud-init, registration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/host_collections","name":"host_collections","apis":[{"api_url":"/api/hosts/:host_id/host_collections","http_method":"PUT","short_description":"Alter a hosts host collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eThe id of the host to alter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","id":"hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/hostgroups","http_method":"GET","short_description":"List all host groups for a Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"class","type":"string"},{"name":"config_group","type":"string"},{"name":"content_source","type":"string"},{"name":"content_view","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/create","name":"create","apis":[{"api_url":"/api/hostgroups","http_method":"POST","short_description":"Create a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/update","name":"update","apis":[{"api_url":"/api/hostgroups/:id","http_method":"PUT","short_description":"Update a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"hostgroup[root_pass]","description":"\n\u003cp\u003eRoot password on provisioned hosts\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_source_id","full_name":"hostgroup[content_source_id]","description":"\n\u003cp\u003eContent source ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"hostgroup[content_view_id]","description":"\n\u003cp\u003eContent view ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"lifecycle_environment_id","full_name":"hostgroup[lifecycle_environment_id]","description":"\n\u003cp\u003eLifecycle environment ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"kickstart_repository_id","full_name":"hostgroup[kickstart_repository_id]","description":"\n\u003cp\u003eKickstart repository ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:id","http_method":"DELETE","short_description":"Delete a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/clone","name":"clone","apis":[{"api_url":"/api/hostgroups/:id/clone","http_method":"POST","short_description":"Clone a host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host,\nContent_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":[]},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","id":"smart_proxies","api_url":"/api","name":"Smart proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/create","name":"create","apis":[{"api_url":"/api/smart_proxies","http_method":"POST","short_description":"Create a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/update","name":"update","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"PUT","short_description":"Update a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"smart_proxy[download_policy]","description":"\n\u003cp\u003eDownload Policy of the capsule, must be one of immediate, on_demand,\nbackground, inherit\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"DELETE","short_description":"Delete a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"../apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template inputs","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"POST","short_description":"Create a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::GpgKey\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"PUT","short_description":"Update a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eForemanTasks::RecurringLogic\u003c/code\u003e, \u003ccode\u003eForemanTasks::Task\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eJobInvocation\u003c/code\u003e, \u003ccode\u003eJobTemplate\u003c/code\u003e, \u003ccode\u003eKatello::ActivationKey\u003c/code\u003e, \u003ccode\u003eKatello::ContentView\u003c/code\u003e, \u003ccode\u003eKatello::GpgKey\u003c/code\u003e, \u003ccode\u003eKatello::HostCollection\u003c/code\u003e, \u003ccode\u003eKatello::KTEnvironment\u003c/code\u003e, \u003ccode\u003eKatello::Product\u003c/code\u003e, \u003ccode\u003eKatello::Subscription\u003c/code\u003e, \u003ccode\u003eKatello::SyncPlan\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eRemoteExecutionFeature\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eTemplateInvocation\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"architectures":{"doc_url":"../apidoc/v2/architectures","id":"architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","id":"template_kinds","api_url":"/api","name":"Template kinds","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"../apidoc/v2/audits","id":"audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"action","type":"string"},{"name":"auditable_id","type":"integer"},{"name":"changes","type":"text"},{"name":"comment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"interface_fqdn","type":"string"},{"name":"interface_ip","type":"string"},{"name":"interface_mac","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_title","type":"string"},{"name":"parameter","type":"string"},{"name":"partition_table","type":"string"},{"name":"provisioning_template","type":"string"},{"name":"puppetclass","type":"string"},{"name":"remote_address","type":"string"},{"name":"request_uuid","type":"string"},{"name":"setting","type":"string"},{"name":"time","type":"datetime"},{"name":"type","values":["role","ptable","provisioning_template","user","filter","architecture","bookmark","compute_profile","config_group","domain","environment","host_class","hostgroup","http_proxy","image","key_pair","medium","model","personal_access_token","report_template","puppetclass","realm","smart_proxy","ssh_key","subnet","usergroup","job_template","job_invocation","remote_execution_feature","katello/repository","katello/host/content_facet","katello/hostgroup/content_facet","katello/host/subscription_facet","katello/activation_key","katello/content_view","katello/gpg_key","katello/host_collection","katello/kt_environment","katello/product","katello/sync_plan","lookup_value","hostgroup_class","auth_source","compute_resource","host","interface","location","organization","os","override_value","parameter","partition_table","setting","smart_class_parameter"]},{"name":"user","type":"string"},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"../apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal access tokens","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"../apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth source externals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/update","name":"update","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"PUT","short_description":"Update an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ping":{"doc_url":"../apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/index","name":"index","apis":[{"api_url":"/katello/api/ping","http_method":"GET","short_description":"Shows status of Katello system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/server_status","name":"server_status","apis":[{"api_url":"/katello/api/status","http_method":"GET","short_description":"Shows version information","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"auth_source_internals":{"doc_url":"../apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth source internals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"plugins":{"doc_url":"../apidoc/v2/plugins","id":"plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","id":"auth_source_ldaps","api_url":"/api","name":"Auth source ldaps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/create","name":"create","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"POST","short_description":"Create an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"trends":{"doc_url":"../apidoc/v2/trends","id":"trends","api_url":"/api","name":"Trends","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API enpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/trends/index","name":"index","apis":[{"api_url":"/api/trends","http_method":"GET","short_description":"List of trends counters","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/show","name":"show","apis":[{"api_url":"/api/trends/:id","http_method":"GET","short_description":"Show a trend","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/create","name":"create","apis":[{"api_url":"/api/trends","http_method":"POST","short_description":"Create a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/destroy","name":"destroy","apis":[{"api_url":"/api/trends/:id","http_method":"DELETE","short_description":"Delete a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"auth_sources":{"doc_url":"../apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth sources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","id":"usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the Foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"autosign":{"doc_url":"../apidoc/v2/autosign","id":"autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"../apidoc/v2/users","id":"users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"last_login_on","type":"datetime"},{"name":"lastname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"login","type":"string"},{"name":"mail","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"usergroup","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show","name":"show","apis":[{"api_url":"/api/users/:id","http_method":"GET","short_description":"Show a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user if it is not already present.\nOnly another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","id":"bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/create","name":"create","apis":[{"api_url":"/api/bookmarks","http_method":"POST","short_description":"Create a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"environment","type":"string"},{"name":"hostgroup","type":"string"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/create","name":"create","apis":[{"api_url":"/api/provisioning_templates","http_method":"POST","short_description":"Create a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/build_pxe_default","name":"build_pxe_default","apis":[{"api_url":"/api/provisioning_templates/build_pxe_default","http_method":"POST","short_description":"Update the default PXE menu on all configured TFTP servers","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/global_registration","name":"global_registration","apis":[{"api_url":"/api/register","http_method":"GET","short_description":"Render Global Registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","id":"common_parameters","api_url":"/api","name":"Common parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/create","name":"create","apis":[{"api_url":"/api/common_parameters","http_method":"POST","short_description":"Create a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"../apidoc/v2/ptables","id":"ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/create","name":"create","apis":[{"api_url":"/api/ptables","http_method":"POST","short_description":"Create a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","id":"compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","id":"puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"key","type":"string"},{"name":"location","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","id":"compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/create","name":"create","apis":[{"api_url":"/api/compute_profiles","http_method":"POST","short_description":"Create a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_hosts":{"doc_url":"../apidoc/v2/puppet_hosts","id":"puppet_hosts","api_url":"/api","name":"Puppet hosts","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Remote Execution Plugin.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nRemote Execution Plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","id":"compute_resources","api_url":"/api","name":"Compute resources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show","name":"show","apis":[{"api_url":"/api/compute_resources/:id","http_method":"GET","short_description":"Show a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/create","name":"create","apis":[{"api_url":"/api/compute_resources","http_method":"POST","short_description":"Create a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_images","name":"available_images","apis":[{"api_url":"/api/compute_resources/:id/available_images","http_method":"GET","short_description":"List available images for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_clusters","name":"available_clusters","apis":[{"api_url":"/api/compute_resources/:id/available_clusters","http_method":"GET","short_description":"List available clusters for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_flavors","name":"available_flavors","apis":[{"api_url":"/api/compute_resources/:id/available_flavors","http_method":"GET","short_description":"List available flavors for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_folders","name":"available_folders","apis":[{"api_url":"/api/compute_resources/:id/available_folders","http_method":"GET","short_description":"List available folders for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_zones","name":"available_zones","apis":[{"api_url":"/api/compute_resources/:id/available_zones","http_method":"GET","short_description":"List available zone for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_networks","name":"available_networks","apis":[{"api_url":"/api/compute_resources/:id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_networks","http_method":"GET","short_description":"List available networks for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/refresh_cache","name":"refresh_cache","apis":[{"api_url":"/api/compute_resources/:id/refresh_cache","http_method":"PUT","short_description":"Refresh Compute Resource Cache","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_virtual_machines","name":"available_virtual_machines","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines","http_method":"GET","short_description":"List available virtual machines for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/show_vm","name":"show_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"GET","short_description":"Show a virtual machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/power_vm","name":"power_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id/power","http_method":"PUT","short_description":"Power a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy_vm","name":"destroy_vm","apis":[{"api_url":"/api/compute_resources/:id/available_virtual_machines/:vm_id","http_method":"DELETE","short_description":"Delete a Virtual Machine","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_groups":{"doc_url":"../apidoc/v2/config_groups","id":"config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"class","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"../apidoc/v2/realms","id":"realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/create","name":"create","apis":[{"api_url":"/api/realms","http_method":"POST","short_description":"Create a realm","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003ename\u003c/strong\u003e field is used for the name of the realm.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"environment","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/create","name":"create","apis":[{"api_url":"/api/config_reports","http_method":"POST","short_description":"Create a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","id":"dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"../apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are of the form\n\u003cem\u003ehostname\u003c/em\u003e.\u003cstrong\u003esomewhere.com\u003c/strong\u003e then the domain is\n\u003cstrong\u003esomewhere.com\u003c/strong\u003e. This allows Foreman to associate a puppet\nvariable with a domain/site and automatically append this variable to all\nexternal node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003efullname\u003c/strong\u003e field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"environments":{"doc_url":"../apidoc/v2/environments","id":"environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/environments","http_method":"GET","short_description":"List environments of Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/environments","http_method":"GET","short_description":"List environments per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view","type":"string"},{"name":"lifecycle_environment","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"../apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/create","name":"create","apis":[{"api_url":"/api/report_templates","http_method":"POST","short_description":"Create a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/generate","name":"generate","apis":[{"api_url":"/api/report_templates/:id/generate","http_method":"POST","short_description":"Generate report from a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action\nreturns an url to get resulting report from (see\n\u003cstrong\u003ereport_data\u003c/strong\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use \u0026#39;,\u0026#39; to\nseparate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API\nendpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is\ndelivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn\u0026#39;t\nbeen generated yet, it will return an empty response with http status 204 -\nNoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","id":"external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","id":"fact_values","api_url":"/api","name":"Fact values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/create","name":"create","apis":[{"api_url":"/api/filters","http_method":"POST","short_description":"Create a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"../apidoc/v2/home","id":"home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_classes":{"doc_url":"../apidoc/v2/host_classes","id":"host_classes","api_url":"/api","name":"Host classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_classes/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"../apidoc/v2/roles","id":"roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroup_classes":{"doc_url":"../apidoc/v2/hostgroup_classes","id":"hostgroup_classes","api_url":"/api","name":"Hostgroup classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroup_classes/index","name":"index","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/create","name":"create","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"../apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/create","name":"create","apis":[{"api_url":"/api/http_proxies","http_method":"POST","short_description":"Create an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"../apidoc/v2/images","id":"images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"../apidoc/v2/locations","id":"locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/show","name":"show","apis":[{"api_url":"/api/locations/:id","http_method":"GET","short_description":"Show a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/create","name":"create","apis":[{"api_url":"/api/locations","http_method":"POST","short_description":"Create a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"../apidoc/v2/settings","id":"settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/create","name":"create","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"POST","short_description":"Add an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"../apidoc/v2/media","id":"media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/create","name":"create","apis":[{"api_url":"/api/media","http_method":"POST","short_description":"Create a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"../apidoc/v2/models","id":"models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/create","name":"create","apis":[{"api_url":"/api/models","http_method":"POST","short_description":"Create a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"../apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","id":"operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"../apidoc/v2/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/katello/api/organizations","http_method":"GET","short_description":"List all organizations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"title","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"GET","short_description":"Show organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/katello/api/organizations","http_method":"POST","short_description":"Create organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"PUT","short_description":"Update organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eorganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"redhat_repository_url","full_name":"redhat_repository_url","description":"\n\u003cp\u003eRed Hat CDN URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_template_ids","full_name":"organization[config_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"organization[label]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:id","http_method":"DELETE","short_description":"Delete an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/repo_discover","name":"repo_discover","apis":[{"api_url":"/katello/api/organizations/:id/repo_discover","http_method":"PUT","short_description":"Discover Repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003eBase URL to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eOne of yum or docker\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword to access URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch pattern (defaults to \u0026#39;*\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/cancel_repo_discover","name":"cancel_repo_discover","apis":[{"api_url":"/katello/api/organizations/:label/cancel_repo_discover","http_method":"PUT","short_description":"Cancel repository discovery","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003ebase url to perform repo discovery on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/download_debug_certificate","name":"download_debug_certificate","apis":[{"api_url":"/katello/api/organizations/:label/download_debug_certificate","http_method":"GET","short_description":"Download a debug certificate","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eOrganization label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/releases","name":"releases","apis":[{"api_url":"/katello/api/organizations/:id/releases","http_method":"GET","short_description":"List available releases in the organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the Organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/redhat_provider","name":"redhat_provider","apis":[{"api_url":"/katello/api/organizations/:id/redhat_provider","http_method":"GET","short_description":"List all :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"tasks":{"doc_url":"../apidoc/v2/tasks","id":"tasks","api_url":"/api","name":"Tasks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","id":"os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/show","name":"show","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"GET","short_description":"Show a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","id":"template_combinations","api_url":"/api","name":"Template combinations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"override_values":{"doc_url":"../apidoc/v2/override_values","id":"override_values","api_url":"/api","name":"Override values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/override_values/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"../apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cstrong\u003enested parameters for a host,\ndomain, subnet, host group, operating system\u003c/strong\u003e. If you are looking\nfor \u0026lt;a href=“common_parameters.html”\u0026gt;global parameters\u0026lt;/a\u0026gt;, go\nto \u0026lt;a href=“common_parameters.html”\u0026gt;this link\u0026lt;/a\u0026gt;.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"../apidoc/v2/permissions","id":"permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/resource_types","name":"resource_types","apis":[{"api_url":"/api/permissions/resource_types","http_method":"GET","short_description":"List available resource types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_class_parameters":{"doc_url":"../apidoc/v2/smart_class_parameters","id":"smart_class_parameters","api_url":"/api","name":"Smart class parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_class_parameters/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters","http_method":"GET","short_description":"List all smart class parameters","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment/Puppet class combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"avoid_duplicates","values":["true","false"]},{"name":"environment","type":"string"},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"},{"name":"puppetclass","type":"string"},{"name":"puppetclass_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"GET","short_description":"Show a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"PUT","short_description":"Update a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"\n\u003cp\u003eWhether the smart class parameter value is managed by Foreman\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003cp\u003eDescription of smart class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"\n\u003cp\u003eValue to use when there is no match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"smart_class_parameter[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"smart_class_parameter[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output. Puppet will\nuse the value defined in the Puppet manifest for this parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"smart_class_parameter[path]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"smart_class_parameter[required]","description":"\n\u003cp\u003eIf true, will raise an error if there is no default value and no matcher\nprovide a value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"smart_class_parameter[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"smart_class_parameter[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"smart_class_parameter[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"../apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"statistics":{"doc_url":"../apidoc/v2/statistics","id":"statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API endpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install the\nForeman Statistics plugin.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"recurring_logics":{"doc_url":"../apidoc/v2/recurring_logics","id":"recurring_logics","api_url":"/api","name":"Recurring logics","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/recurring_logics/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/recurring_logics","http_method":"GET","short_description":"List recurring logics","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"GET","short_description":"Show recurring logic details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/update","name":"update","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id","http_method":"PUT","short_description":"Update recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eWhether the recurring logic is enabled or disabled.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/cancel","name":"cancel","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/:id/cancel","http_method":"POST","short_description":"Cancel recurring logic","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the recurring logic\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/recurring_logics/bulk_destroy","name":"bulk_destroy","apis":[{"api_url":"/foreman_tasks/api/recurring_logics/bulk_destroy","http_method":"POST","short_description":"Delete recurring logics by search query","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch query\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreman_tasks":{"doc_url":"../apidoc/v2/foreman_tasks","id":"foreman_tasks","api_url":"/api","name":"Foreman tasks","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreman_tasks/summary","name":"summary","apis":[{"api_url":"/foreman_tasks/api/tasks/summary","http_method":"GET","short_description":"Show task summary","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/show","name":"show","apis":[{"api_url":"/foreman_tasks/api/tasks/:id","http_method":"GET","short_description":"Show task details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/details","name":"details","apis":[{"api_url":"/foreman_tasks/api/tasks/:id/details","http_method":"GET","short_description":"Show task extended details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_search","name":"bulk_search","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_search","http_method":"POST","short_description":"List dynflow tasks for uuids","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eFor every search it returns the list of tasks that satisfty the condition.\nThe reason for supporting multiple searches is the UI that might be ending\nneeding periodic updates on task status for various searches at the same\ntime. This way, it is possible to get all the task statuses with one\nrequest.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"searches","full_name":"searches","description":"\n\u003cp\u003eList of uuids to fetch info about\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"search_id","full_name":"searches[search_id]","description":"\n\u003cp\u003eArbitraty value for client to identify the the request parts with results.\nIt\u0026#39;s passed in the results to be able to pair the requests and\nresponses properly.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"searches[type]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003eresource\u003c/code\u003e, \u003ccode\u003etask\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_id","full_name":"searches[task_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;task\u0026#39;, find the task by the uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"searches[user_id]","description":"\n\u003cp\u003eIn case :type = \u0026#39;user\u0026#39;, find tasks for the user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource type we\u0026#39;re searching\nthe tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"searches[resource_type]","description":"\n\u003cp\u003eIn case :type = \u0026#39;resource\u0026#39;, what resource id we\u0026#39;re searching\nthe tasks for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"action_types","full_name":"searches[action_types]","description":"\n\u003cp\u003eReturn just tasks of given action type, e.g.\n[“Actions::Katello::Repository::Synchronize”]\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eString\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"active_only","full_name":"searches[active_only]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"searches[page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"searches[per_page]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_resume","name":"bulk_resume","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_resume","http_method":"POST","short_description":"Resume all paused error tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eResume tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eResume specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_cancel","name":"bulk_cancel","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_cancel","http_method":"POST","short_description":"Cancel all cancellable tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eCancel tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eCancel specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/bulk_stop","name":"bulk_stop","apis":[{"api_url":"/foreman_tasks/api/tasks/bulk_stop","http_method":"POST","short_description":"Stop all stoppable tasks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eStop tasks matching search string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"task_ids","full_name":"task_ids","description":"\n\u003cp\u003eStop specific tasks by ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/index","name":"index","apis":[{"api_url":"/foreman_tasks/api/tasks","http_method":"GET","short_description":"List tasks","deprecated":null},{"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreman_tasks/callback","name":"callback","apis":[{"api_url":"/foreman_tasks/api/tasks/callback","http_method":"POST","short_description":"Send data to the task from external executor (such as smart_proxy_dynflow)","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"callback","full_name":"callback","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"task_id","full_name":"callback[task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"step_id","full_name":"callback[step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"data","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"callbacks","full_name":"callbacks","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"callback","full_name":"callbacks[callback]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"task_id","full_name":"callbacks[callback][task_id]","description":"\n\u003cp\u003eUUID of the task\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"step_id","full_name":"callbacks[callback][step_id]","description":"\n\u003cp\u003eThe ID of the step inside the execution plan to send the event to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"data","full_name":"callbacks[data]","description":"\n\u003cp\u003eData to be sent to the action\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"foreign_input_sets":{"doc_url":"../apidoc/v2/foreign_input_sets","id":"foreign_input_sets","api_url":"/api","name":"Foreign input sets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/foreign_input_sets/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"GET","short_description":"List foreign input sets","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"GET","short_description":"Show foreign input set details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/create","name":"create","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets","http_method":"POST","short_description":"Create a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"DELETE","short_description":"Delete a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/foreign_input_sets/update","name":"update","apis":[{"api_url":"/api/templates/:template_id/foreign_input_sets/:id","http_method":"PUT","short_description":"Update a foreign input set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"foreign_input_set","full_name":"foreign_input_set","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"target_template_id","full_name":"foreign_input_set[target_template_id]","description":"\n\u003cp\u003eTarget template ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include_all","full_name":"foreign_input_set[include_all]","description":"\n\u003cp\u003eInclude all inputs from the foreign template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"foreign_input_set[include]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"exclude","full_name":"foreign_input_set[exclude]","description":"\n\u003cp\u003eA comma separated list of input names to be included from the foreign\ntemplate.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"foreign_input_set[description]","description":"\n\u003cp\u003eInput set description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_invocations":{"doc_url":"../apidoc/v2/job_invocations","id":"job_invocations","api_url":"/api","name":"Job invocations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/job_invocations/index","name":"index","apis":[{"api_url":"/api/job_invocations","http_method":"GET","short_description":"List job invocations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/show","name":"show","apis":[{"api_url":"/api/job_invocations/:id","http_method":"GET","short_description":"Show job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_status","full_name":"host_status","description":"\n\u003cp\u003eShow Job status for the hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/create","name":"create","apis":[{"api_url":"/api/job_invocations","http_method":"POST","short_description":"Create a job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_invocation","full_name":"job_invocation","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"job_template_id","full_name":"job_invocation[job_template_id]","description":"\n\u003cp\u003eThe job template to use, parameter is required unless feature was specified\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"targeting_type","full_name":"job_invocation[targeting_type]","description":"\n\u003cp\u003eInvocation type, one of {“static_query”=\u0026gt;“Static Query”,\n“dynamic_query”=\u0026gt;“Dynamic Query”}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"randomized_ordering","full_name":"job_invocation[randomized_ordering]","description":"\n\u003cp\u003eExecute the jobs on hosts in randomized order\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inputs","full_name":"job_invocation[inputs]","description":"\n\u003cp\u003eInputs to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"ssh","full_name":"job_invocation[ssh]","description":"\n\u003cp\u003eSSH provider specific options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"effective_user","full_name":"job_invocation[ssh][effective_user]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms).\nDefaults to a template parameter or global setting.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"recurrence","full_name":"job_invocation[recurrence]","description":"\n\u003cp\u003eCreate a recurring job\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"cron_line","full_name":"job_invocation[recurrence][cron_line]","description":"\n\u003cp\u003eHow often the job should occur, in the cron format\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_iteration","full_name":"job_invocation[recurrence][max_iteration]","description":"\n\u003cp\u003eRepeat a maximum of N times\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"end_time","full_name":"job_invocation[recurrence][end_time]","description":"\n\u003cp\u003ePerform no more executions after this time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"scheduling","full_name":"job_invocation[scheduling]","description":"\n\u003cp\u003eSchedule the job to start at a later time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"start_at","full_name":"job_invocation[scheduling][start_at]","description":"\n\u003cp\u003eSchedule the job for a future time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_before","full_name":"job_invocation[scheduling][start_before]","description":"\n\u003cp\u003eIndicates that the action should be cancelled if it cannot be started\nbefore this time.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"concurrency_control","full_name":"job_invocation[concurrency_control]","description":"\n\u003cp\u003eControl concurrency level and distribution over time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"time_span","full_name":"job_invocation[concurrency_control][time_span]","description":"\n\u003cp\u003eDistribute tasks over N seconds\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"concurrency_level","full_name":"job_invocation[concurrency_control][concurrency_level]","description":"\n\u003cp\u003eRun at most N tasks at a time\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"bookmark_id","full_name":"job_invocation[bookmark_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search_query","full_name":"job_invocation[search_query]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_invocation[description_format]","description":"\n\u003cp\u003eOverride the description format from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"execution_timeout_interval","full_name":"job_invocation[execution_timeout_interval]","description":"\n\u003cp\u003eOverride the timeout interval from the template for this invocation only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"feature","full_name":"job_invocation[feature]","description":"\n\u003cp\u003eRemote execution feature label that should be triggered, job template\nassigned to this feature will be used\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/output","name":"output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id","http_method":"GET","short_description":"Get output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/raw_output","name":"raw_output","apis":[{"api_url":"/api/job_invocations/:id/hosts/:host_id/raw","http_method":"GET","short_description":"Get raw output for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/cancel","name":"cancel","apis":[{"api_url":"/api/job_invocations/:id/cancel","http_method":"POST","short_description":"Cancel job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_invocations/rerun","name":"rerun","apis":[{"api_url":"/api/job_invocations/:id/rerun","http_method":"POST","short_description":"Rerun job on failed hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"failed_only","full_name":"failed_only","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"job_templates":{"doc_url":"../apidoc/v2/job_templates","id":"job_templates","api_url":"/api","name":"Job templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/job_templates/index","name":"index","apis":[{"api_url":"/api/job_templates","http_method":"GET","short_description":"List job templates","deprecated":null},{"api_url":"/api/locations/:location_id/job_templates","http_method":"GET","short_description":"List job templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/job_templates","http_method":"GET","short_description":"List job templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/import","name":"import","apis":[{"api_url":"/api/job_templates/import","http_method":"POST","short_description":"Import a job template from ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"template","description":"\n\u003cp\u003eTemplate ERB\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overwrite","full_name":"overwrite","description":"\n\u003cp\u003eOverwrite template if it already exists\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/export","name":"export","apis":[{"api_url":"/api/job_templates/:id/export","http_method":"GET","short_description":"Export a job template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/show","name":"show","apis":[{"api_url":"/api/job_templates/:id","http_method":"GET","short_description":"Show job template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/create","name":"create","apis":[{"api_url":"/api/job_templates","http_method":"POST","short_description":"Create a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"job_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the\ninvocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/update","name":"update","apis":[{"api_url":"/api/job_templates/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"job_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_category","full_name":"job_template[job_category]","description":"\n\u003cp\u003eJob category\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description_format","full_name":"job_template[description_format]","description":"\n\u003cp\u003eThis template is used to generate the description. Input values can be used\nusing the syntax %{package}. You may also include the job category and\ntemplate name using %{job_category} and %{template_name}.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"job_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider_type","full_name":"job_template[provider_type]","description":"\n\u003cp\u003eProvider type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"job_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"job_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"job_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"effective_user_attributes","full_name":"job_template[effective_user_attributes]","description":"\n\u003cp\u003eEffective user options\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"job_template[effective_user_attributes][value]","description":"\n\u003cp\u003eWhat user should be used to run the script (using sudo-like mechanisms)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"overridable","full_name":"job_template[effective_user_attributes][overridable]","description":"\n\u003cp\u003eWhether it should be allowed to override the effective user from the\ninvocation form.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"current_user","full_name":"job_template[effective_user_attributes][current_user]","description":"\n\u003cp\u003eWhether the current user login should be used as the effective user\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"location_ids","full_name":"job_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"job_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/revision","name":"revision","apis":[{"api_url":"/api/job_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eTemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/destroy","name":"destroy","apis":[{"api_url":"/api/job_templates/:id","http_method":"DELETE","short_description":"Delete a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/job_templates/clone","name":"clone","apis":[{"api_url":"/api/job_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_template","full_name":"job_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"job_template[name]","description":"\n\u003cp\u003eTemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"remote_execution_features":{"doc_url":"../apidoc/v2/remote_execution_features","id":"remote_execution_features","api_url":"/api","name":"Remote execution features","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/remote_execution_features/index","name":"index","apis":[{"api_url":"/api/remote_execution_features","http_method":"GET","short_description":"List remote execution features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/remote_execution_features/show","name":"show","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"GET","short_description":"Show remote execution feature","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/remote_execution_features/update","name":"update","apis":[{"api_url":"/api/remote_execution_features/:id","http_method":"PUT","short_description":"Update a job template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remote_execution_feature","full_name":"remote_execution_feature","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"job_template_id","full_name":"remote_execution_feature[job_template_id]","description":"\n\u003cp\u003eJob template ID to be used for the feature\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_invocations":{"doc_url":"../apidoc/v2/template_invocations","id":"template_invocations","api_url":"/api","name":"Template invocations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_invocations/template_invocations","name":"template_invocations","apis":[{"api_url":"/api/job_invocations/:job_invocation_id/template_invocations","http_method":"GET","short_description":"List template invocations belonging to job invocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"job_invocation_id","full_name":"job_invocation_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_modules":{"doc_url":"../apidoc/v2/puppet_modules","id":"puppet_modules","api_url":"/api","name":"Puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/puppet_modules/:id","http_method":"GET","short_description":"Show a puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea puppet module identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppet_modules/compare","name":"compare","apis":[{"api_url":"/katello/api/puppet_modules/compare","http_method":"GET","short_description":"List puppet_modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"activation_keys":{"doc_url":"../apidoc/v2/activation_keys","id":"activation_keys","api_url":"/api","name":"Activation keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/activation_keys/index","name":"index","apis":[{"api_url":"/katello/api/activation_keys","http_method":"GET","short_description":"List activation keys","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/activation_keys","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eactivation key name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"addon","type":"string"},{"name":"content_view","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"environment","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"role","type":"string"},{"name":"subscription_id","type":"string"},{"name":"subscription_name","type":"string"},{"name":"usage","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/create","name":"create","apis":[{"api_url":"/katello/api/activation_keys","http_method":"POST","short_description":"Create an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"\n\u003cp\u003eenvironment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/update","name":"update","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"PUT","short_description":"Update an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003emaximum number of registered content hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003ecan the activation key have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"service_level","full_name":"service_level","description":"\n\u003cp\u003eservice level\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_attach","full_name":"auto_attach","description":"\n\u003cp\u003eauto attach subscriptions upon registration\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"purpose_usage","full_name":"purpose_usage","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_role","full_name":"purpose_role","description":"\n\u003cp\u003eSets the system purpose usage\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose_addons","full_name":"purpose_addons","description":"\n\u003cp\u003eSets the system add-ons\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"DELETE","short_description":"Destroy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/show","name":"show","apis":[{"api_url":"/katello/api/activation_keys/:id","http_method":"GET","short_description":"Show an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/copy","name":"copy","apis":[{"api_url":"/katello/api/activation_keys/:id/copy","http_method":"POST","short_description":"Copy an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003eName of new activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_host_collections","name":"available_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections/available","http_method":"GET","short_description":"List host collections the activation key does not belong to","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/available_releases","name":"available_releases","apis":[{"api_url":"/katello/api/activation_keys/:id/releases","http_method":"GET","short_description":"Show release versions available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/product_content","name":"product_content","apis":[{"api_url":"/katello/api/activation_keys/:id/product_content","http_method":"GET","short_description":"Show content available for an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_all","full_name":"content_access_mode_all","description":"\n\u003cp\u003eGet all content available, not just that provided by subscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_access_mode_env","full_name":"content_access_mode_env","description":"\n\u003cp\u003eLimit content to just that available in the activation key\u0026#39;s content\nview version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_host_collections","name":"add_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"POST","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to associate with activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_host_collections","name":"remove_host_collections","apis":[{"api_url":"/katello/api/activation_keys/:id/host_collections","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection IDs to disassociate from the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/add_subscriptions","http_method":"PUT","short_description":"Attach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"quantity","description":"\n\u003cp\u003eQuantity of this subscription to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/katello/api/activation_keys/:id/remove_subscriptions","http_method":"PUT","short_description":"Unattach a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eSubscription ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/activation_keys/content_override","name":"content_override","apis":[{"api_url":"/katello/api/activation_keys/:id/content_override","http_method":"PUT","short_description":"Override content for activation_key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the activation key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters to be added in bulk\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride parameter key or name. Note if name is not provided the default\nname will be \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repositories_bulk_actions":{"doc_url":"../apidoc/v2/repositories_bulk_actions","id":"repositories_bulk_actions","api_url":"/api","name":"Repositories bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories_bulk_actions/destroy_repositories","name":"destroy_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more repositories","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories_bulk_actions/sync_repositories","name":"sync_repositories","apis":[{"api_url":"/katello/api/repositories/bulk/sync","http_method":"POST","short_description":"Synchronize repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ansible_collections":{"doc_url":"../apidoc/v2/ansible_collections","id":"ansible_collections","api_url":"/api","name":"Ansible Collections","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ansible_collections/index","name":"index","apis":[{"api_url":"/katello/api/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_collections/show","name":"show","apis":[{"api_url":"/katello/api/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ansible_collections/:id","http_method":"GET","short_description":"Show an ansible collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ansible collection identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ansible_collections/compare","name":"compare","apis":[{"api_url":"/katello/api/ansible_collections/compare","http_method":"GET","short_description":"List ansible_collections","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"repositories":{"doc_url":"../apidoc/v2/repositories","id":"repositories","api_url":"/api","name":"Repositories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repositories/index","name":"index","apis":[{"api_url":"/katello/api/repositories","http_method":"GET","short_description":"List of enabled repositories","deprecated":null},{"api_url":"/katello/api/content_views/:id/repositories","http_method":"GET","short_description":"List of repositories for a content view","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/repositories","http_method":"GET","short_description":"List of repositories in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id/repositories","http_method":"GET","short_description":"List repositories in the environment","deprecated":null},{"api_url":"/katello/api/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories for a product","deprecated":null},{"api_url":"/katello/api/environments/:environment_id/products/:product_id/repositories","http_method":"GET","short_description":"List of repositories belonging to a product in an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of an organization to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to show repositories of\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of an environment to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eID of a content view to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eID of a content view version to show repositories in\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_id","full_name":"deb_id","description":"\n\u003cp\u003eId of a deb package to find repositories that contain the deb\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"erratum_id","full_name":"erratum_id","description":"\n\u003cp\u003eId of an erratum to find repositories that contain the erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rpm_id","full_name":"rpm_id","description":"\n\u003cp\u003eId of a rpm package to find repositories that contain the rpm\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"file_id","full_name":"file_id","description":"\n\u003cp\u003eId of a file to find repositories that contain the file\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_id","full_name":"ansible_collection_id","description":"\n\u003cp\u003eId of an ansible collection to find repositories that contain the ansible\ncollection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_branch_id","full_name":"ostree_branch_id","description":"\n\u003cp\u003eId of an ostree branch to find repositories that contain that branch\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"library","full_name":"library","description":"\n\u003cp\u003eshow repositories in Library and the default content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"archived","full_name":"archived","description":"\n\u003cp\u003eshow archived repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003elimit to only repositories of this type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003einterpret specified object to return only Repositories that can be\nassociated with specified object. Only \u0026#39;content_view\u0026#39; \u0026amp;\n\u0026#39;content_view_version\u0026#39; are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"with_content","full_name":"with_content","description":"\n\u003cp\u003eonly repositories having at least one of the specified content type ex: rpm\n, erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003edocker_manifest_list\u003c/code\u003e, \u003ccode\u003edocker_tag\u003c/code\u003e, \u003ccode\u003edocker_blob\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003emodulemd\u003c/code\u003e, \u003ccode\u003eerratum\u003c/code\u003e, \u003ccode\u003edistribution\u003c/code\u003e, \u003ccode\u003epackage_category\u003c/code\u003e, \u003ccode\u003epackage_group\u003c/code\u003e, \u003ccode\u003eyum_repo_metadata_file\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"container_repository_name","type":"string"},{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"content_view_id","type":"integer"},{"name":"description","type":"text"},{"name":"distribution_arch","type":"string"},{"name":"distribution_bootable","type":"boolean"},{"name":"distribution_family","type":"string"},{"name":"distribution_variant","type":"string"},{"name":"distribution_version","type":"string"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/create","name":"create","apis":[{"api_url":"/katello/api/repositories","http_method":"POST","short_description":"Create a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the repository\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eProduct the repository belongs to\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of repo\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet\u003c/code\u003e, \u003ccode\u003eyum\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39;\nare supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_tags_whitelist","full_name":"docker_tags_whitelist","description":"\n\u003cp\u003eComma separated list of tags to sync for Container Image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either \u0026#39;immediate\u0026#39;,\n\u0026#39;on_demand\u0026#39;, or \u0026#39;background (deprecated)\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e, \u003ccode\u003ebackground\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"download_concurrency","full_name":"download_concurrency","description":"\n\u003cp\u003eUsed to determine download concurrency of the repository in pulp3. Use\nvalue 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":[]},{"name":"mirror_on_sync","full_name":"mirror_on_sync","description":"\n\u003cp\u003etrue if this repository when synced has to be mirrored from the source and\nstale rpms removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are\nsigned by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_policy","full_name":"ostree_upstream_sync_policy","description":"\n\u003cp\u003epolicies for syncing upstream ostree repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elatest\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_depth","full_name":"ostree_upstream_sync_depth","description":"\n\u003cp\u003eif a custom sync policy is chosen for ostree repositories then a\n\u0026#39;depth\u0026#39; value must be provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ecomma separated list of releases to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ecomma separated list of repo components to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ecomma separated list of architectures to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ignore_global_proxy","full_name":"ignore_global_proxy","description":"\n\u003cp\u003eif true, will ignore the globally configured proxy when syncing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/repository_types","name":"repository_types","apis":[{"api_url":"/katello/api/repositories/repository_types","http_method":"GET","short_description":"Show the available repository types","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"creatable","full_name":"creatable","description":"\n\u003cp\u003eWhen set to \u0026#39;True\u0026#39; repository types that are creatable will be\nreturned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/republish","name":"republish","apis":[{"api_url":"/katello/api/repositories/:id/republish","http_method":"PUT","short_description":"Forces a republish of the specified repository, regenerating metadata and symlinks on the filesystem.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/show","name":"show","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"GET","short_description":"Show a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/sync","name":"sync","apis":[{"api_url":"/katello/api/repositories/:id/sync","http_method":"POST","short_description":"Sync a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"source_url","full_name":"source_url","description":"\n\u003cp\u003etemporarily override feed URL for sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"incremental","full_name":"incremental","description":"\n\u003cp\u003eperform an incremental import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Only used with yum\nrepositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Only used with yum\nrepositories.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/export","name":"export","apis":[{"api_url":"/katello/api/repositories/:id/export","http_method":"POST","short_description":"Export a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"url","description":"\n\u003cp\u003erepository source url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eid of the gpg key that will be assigned to the new repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the content credential containing the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unprotected","full_name":"unprotected","description":"\n\u003cp\u003etrue if this repository can be published via HTTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"checksum_type","full_name":"checksum_type","description":"\n\u003cp\u003eChecksum of the repository, currently \u0026#39;sha1\u0026#39; \u0026amp; \u0026#39;sha256\u0026#39;\nare supported\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_upstream_name","full_name":"docker_upstream_name","description":"\n\u003cp\u003eName of the upstream docker repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"docker_tags_whitelist","full_name":"docker_tags_whitelist","description":"\n\u003cp\u003eComma separated list of tags to sync for Container Image repository\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"download_policy","full_name":"download_policy","description":"\n\u003cp\u003edownload policy for yum repos (either \u0026#39;immediate\u0026#39;,\n\u0026#39;on_demand\u0026#39;, or \u0026#39;background (deprecated)\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eimmediate\u003c/code\u003e, \u003ccode\u003eon_demand\u003c/code\u003e, \u003ccode\u003ebackground\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"download_concurrency","full_name":"download_concurrency","description":"\n\u003cp\u003eUsed to determine download concurrency of the repository in pulp3. Use\nvalue 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":[]},{"name":"mirror_on_sync","full_name":"mirror_on_sync","description":"\n\u003cp\u003etrue if this repository when synced has to be mirrored from the source and\nstale rpms removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"verify_ssl_on_sync","full_name":"verify_ssl_on_sync","description":"\n\u003cp\u003eif true, Katello will verify the upstream url\u0026#39;s SSL certifcates are\nsigned by a trusted CA\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"upstream_username","full_name":"upstream_username","description":"\n\u003cp\u003eUsername of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"upstream_password","full_name":"upstream_password","description":"\n\u003cp\u003ePassword of the upstream repository user used for authentication\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_policy","full_name":"ostree_upstream_sync_policy","description":"\n\u003cp\u003epolicies for syncing upstream ostree repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003elatest\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003ecustom\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ostree_upstream_sync_depth","full_name":"ostree_upstream_sync_depth","description":"\n\u003cp\u003eif a custom sync policy is chosen for ostree repositories then a\n\u0026#39;depth\u0026#39; value must be provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"deb_releases","full_name":"deb_releases","description":"\n\u003cp\u003ecomma separated list of releases to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_components","full_name":"deb_components","description":"\n\u003cp\u003ecomma separated list of repo components to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"deb_architectures","full_name":"deb_architectures","description":"\n\u003cp\u003ecomma separated list of architectures to be synched from deb-archive\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ignore_global_proxy","full_name":"ignore_global_proxy","description":"\n\u003cp\u003eif true, will ignore the globally configured proxy when syncing\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ignorable_content","full_name":"ignorable_content","description":"\n\u003cp\u003eList of content units to ignore while syncing a yum repository. Must be\nsubset of rpm,drpm,srpm,distribution,erratum\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ansible_collection_requirements","full_name":"ansible_collection_requirements","description":"\n\u003cp\u003eContents of requirement yaml file to sync from URL\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicies for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eID of a HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:id","http_method":"DELETE","short_description":"Destroy a custom repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/remove_content","name":"remove_content","apis":[{"api_url":"/katello/api/repositories/:id/remove_packages","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_docker_manifests","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_puppet_modules","http_method":"PUT","short_description":null,"deprecated":null},{"api_url":"/katello/api/repositories/:id/remove_content","http_method":"PUT","short_description":null,"deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eRemove content from a repository\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eArray of content ids to remove\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/upload_content","name":"upload_content","apis":[{"api_url":"/katello/api/repositories/:id/upload_content","http_method":"POST","short_description":"Upload content into the repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003erepository ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent files to upload. Can be a single file or array of files.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/import_uploads","name":"import_uploads","apis":[{"api_url":"/katello/api/repositories/:id/import_uploads","http_method":"PUT","short_description":"Import uploads into a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the ImportUpload action to finish. Default: false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"publish_repository","full_name":"publish_repository","description":"\n\u003cp\u003eWhether or not to regenerate the repository on disk. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sync_capsule","full_name":"sync_capsule","description":"\n\u003cp\u003eWhether or not to sync an external capsule after upload. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uploads","full_name":"uploads","description":"\n\u003cp\u003eArray of uploads to import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"uploads[id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_unit_id","full_name":"uploads[content_unit_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"uploads[size]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"checksum","full_name":"uploads[checksum]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"uploads[name]","description":"\n\u003cp\u003eNeeds to only be set for file repositories or docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"digest","full_name":"uploads[digest]","description":"\n\u003cp\u003eNeeds to only be set for docker tags\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repositories/gpg_key_content","name":"gpg_key_content","apis":[{"api_url":"/katello/api/repositories/:id/gpg_key_content","http_method":"GET","short_description":"Return the content of a repo gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"capsule_content":{"doc_url":"../apidoc/v2/capsule_content","id":"capsule_content","api_url":"/api","name":"Capsule content","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsule_content/lifecycle_environments","name":"lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/available_lifecycle_environments","name":"available_lifecycle_environments","apis":[{"api_url":"/katello/api/capsules/:id/content/available_lifecycle_environments","http_method":"GET","short_description":"List the lifecycle environments not attached to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to limit environments on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/add_lifecycle_environment","name":"add_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments","http_method":"POST","short_description":"Add lifecycle environments to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/remove_lifecycle_environment","name":"remove_lifecycle_environment","apis":[{"api_url":"/katello/api/capsules/:id/content/lifecycle_environments/:environment_id","http_method":"DELETE","short_description":"Remove lifecycle environments from the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the lifecycle environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync","name":"sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"POST","short_description":"Synchronize the content to the smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eId of the environment to limit the synchronization on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eSkip metadata check on each repository on the smart proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/sync_status","name":"sync_status","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"GET","short_description":"Get current smart proxy synchronization status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eId of the organization to get the status for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsule_content/cancel_sync","name":"cancel_sync","apis":[{"api_url":"/katello/api/capsules/:id/content/sync","http_method":"DELETE","short_description":"Cancel running smart proxy synchronization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"capsules":{"doc_url":"../apidoc/v2/capsules","id":"capsules","api_url":"/api","name":"Capsules","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/capsules/index","name":"index","apis":[{"api_url":"/katello/api/capsules","http_method":"GET","short_description":"List all smart proxies that have content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/capsules/show","name":"show","apis":[{"api_url":"/katello/api/capsules/:id","http_method":"GET","short_description":"Show the smart proxy details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the smart proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"sync_plans":{"doc_url":"../apidoc/v2/sync_plans","id":"sync_plans","api_url":"/api","name":"Sync plans","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync_plans/index","name":"index","apis":[{"api_url":"/katello/api/sync_plans","http_method":"GET","short_description":"List sync plans","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003efilter by sync date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003efilter by interval\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"enabled","values":["true","false"]},{"name":"interval","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"GET","short_description":"Show a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans","http_method":"POST","short_description":"Create a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"PUT","short_description":"Update a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003esync plan name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003ehow often synchronization should run\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ehourly\u003c/code\u003e, \u003ccode\u003edaily\u003c/code\u003e, \u003ccode\u003eweekly\u003c/code\u003e, \u003ccode\u003ecustom cron\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sync_date","full_name":"sync_date","description":"\n\u003cp\u003estart datetime of synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003esync plan description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eenables or disables synchronization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"cron_expression","full_name":"cron_expression","description":"\n\u003cp\u003eAdd custom cron logic for sync plan\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null},{"api_url":"/katello/api/sync_plans/:id","http_method":"DELETE","short_description":"Destroy a sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003esync plan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/add_products","name":"add_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/add_products","http_method":"PUT","short_description":"Add products to sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to add to the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/remove_products","name":"remove_products","apis":[{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/remove_products","http_method":"PUT","short_description":"Remove products from sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"product_ids","full_name":"product_ids","description":"\n\u003cp\u003eList of product ids to remove from the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/sync_plans/sync","name":"sync","apis":[{"api_url":"/katello/api/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:id/sync","http_method":"PUT","short_description":"Initiate a sync of the products attached to the sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the sync plan\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_credentials":{"doc_url":"../apidoc/v2/content_credentials","id":"content_credentials","api_url":"/api","name":"Content credentials","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eContent Credentials are used to store credentials like GPG Keys and\nCertificates for the authentication to Products / Repositories.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_credentials/index","name":"index","apis":[{"api_url":"/katello/api/content_credentials","http_method":"GET","short_description":"List content credentials","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the Content Credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/create","name":"create","apis":[{"api_url":"/katello/api/content_credentials","http_method":"POST","short_description":"Create a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the content credential\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/show","name":"show","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"GET","short_description":"Show a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/update","name":"update","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"PUT","short_description":"Update a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the content credential\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003etype of content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding or certificate content\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_credentials/:id","http_method":"DELETE","short_description":"Destroy a content credential","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/content","name":"content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"GET","short_description":"Return the content of a content credential, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_credentials/set_content","name":"set_content","apis":[{"api_url":"/katello/api/content_credentials/:id/content","http_method":"POST","short_description":"Upload content credential contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent credential numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003efile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"upstream_subscriptions":{"doc_url":"../apidoc/v2/upstream_subscriptions","id":"upstream_subscriptions","api_url":"/api","name":"Upstream subscriptions","short_description":null,"full_description":"\n\u003cp\u003eRed Hat subscriptions management platform.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/upstream_subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"GET","short_description":"List available subscriptions from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eThe order to sort the results in. [\u0026#39;asc\u0026#39;, \u0026#39;desc\u0026#39;] Defaults\nto \u0026#39;desc\u0026#39;.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eThe field to sort the data by. Defaults to the created date.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eReturn only the upstream pools which map to the given Katello pool IDs\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"quantities_only","full_name":"quantities_only","description":"\n\u003cp\u003eOnly returns id and quantity fields\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"attachable","full_name":"attachable","description":"\n\u003cp\u003eReturn only subscriptions which can be attached to the upstream allocation\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/update","name":"update","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"PUT","short_description":"Update the quantity of one or more subscriptions on an upstream allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of Pools to be updated. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eKatello ID of local pool to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eDesired quantity of the pool\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"DELETE","short_description":"Remove one or more subscriptions from an upstream subscription allocation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pool_ids","full_name":"pool_ids","description":"\n\u003cp\u003eArray of local pool IDs. Only pools originating upstream are accepted.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions","http_method":"POST","short_description":"Add subscriptions consumed by a manifest from Red Hat Subscription Management","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"pools","full_name":"pools","description":"\n\u003cp\u003eArray of pools to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"pools[id]","description":"\n\u003cp\u003eCandlepin ID of pool to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"pools[quantity]","description":"\n\u003cp\u003eQuantity of entitlements to bind\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/ping","name":"ping","apis":[{"api_url":"/katello/api/organizations/:organization_id/upstream_subscriptions/ping","http_method":"GET","short_description":"Check if a connection can be made to Red Hat Subscription Management.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/enable_simple_content_access","name":"enable_simple_content_access","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/enable","http_method":"PUT","short_description":"Enable simple content access for a manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/upstream_subscriptions/disable_simple_content_access","name":"disable_simple_content_access","apis":[{"api_url":"/katello/api/organizations/:organization_id/simple_content_access/disable","http_method":"PUT","short_description":"Disable simple content access for a 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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_uploads":{"doc_url":"../apidoc/v2/content_uploads","id":"content_uploads","api_url":"/api","name":"Content uploads","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_uploads/create","name":"create","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads","http_method":"POST","short_description":"Create an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"checksum","full_name":"checksum","description":"\n\u003cp\u003eChecksum of file to upload\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003econtent type (\u0026#39;deb\u0026#39;, \u0026#39;docker_manifest\u0026#39;, \u0026#39;file\u0026#39;,\n\u0026#39;ostree\u0026#39;, \u0026#39;puppet_module\u0026#39;, \u0026#39;rpm\u0026#39;, \u0026#39;srpm\u0026#39;)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003edeb\u003c/code\u003e, \u003ccode\u003edocker_manifest\u003c/code\u003e, \u003ccode\u003efile\u003c/code\u003e, \u003ccode\u003epuppet_module\u003c/code\u003e, \u003ccode\u003erpm\u003c/code\u003e, \u003ccode\u003esrpm\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/update","name":"update","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"PUT","short_description":"Upload a chunk of the file's content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"size","full_name":"size","description":"\n\u003cp\u003eSize of file to upload\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"offset","full_name":"offset","description":"\n\u003cp\u003eThe offset in the file where the content starts\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eThe actual file contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_uploads/destroy","name":"destroy","apis":[{"api_url":"/katello/api/repositories/:repository_id/content_uploads/:id","http_method":"DELETE","short_description":"Delete an upload request","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eUpload request id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"packages":{"doc_url":"../apidoc/v2/packages","id":"packages","api_url":"/api","name":"Packages","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/packages/index","name":"index","apis":[{"api_url":"/katello/api/packages","http_method":"GET","short_description":"List packages","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/:resource_id","http_method":"GET","short_description":"List :resource_id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003ePackage identifiers to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable packages for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_applicable","full_name":"packages_restrict_applicable","description":"\n\u003cp\u003eReturn packages that are applicable to one or more hosts (defaults to true\nif host_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_upgradable","full_name":"packages_restrict_upgradable","description":"\n\u003cp\u003eReturn packages that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"packages_restrict_latest","full_name":"packages_restrict_latest","description":"\n\u003cp\u003eReturn only the latest version of each package\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn packages that can be added to the specified object. Only the value\n\u0026#39;content_view_version\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/show","name":"show","apis":[{"api_url":"/katello/api/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/packages/:id","http_method":"GET","short_description":"Show a package","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/packages/compare","name":"compare","apis":[{"api_url":"/katello/api/packages/compare","http_method":"GET","short_description":"List packages","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_components":{"doc_url":"../apidoc/v2/content_view_components","id":"content_view_components","api_url":"/api","name":"Content view components","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_components/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components","http_method":"GET","short_description":"List components attached to this content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/add_components","name":"add_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/add","http_method":"PUT","short_description":"Add components to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"components","full_name":"components","description":"\n\u003cp\u003eArray of components to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_version_id","full_name":"components[content_view_version_id]","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"components[content_view_id]","description":"\n\u003cp\u003econtent view identifier of the component who\u0026#39;s latest version is\ndesired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"latest","full_name":"components[latest]","description":"\n\u003cp\u003etrue if the latest version of the component\u0026#39;s content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/remove_components","name":"remove_components","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/remove","http_method":"PUT","short_description":"Remove components from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eArray of content view component IDs to remove. Identifier of the component\nassociation\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"GET","short_description":"Show a content view component","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_components/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:composite_content_view_id/content_view_components/:id","http_method":"PUT","short_description":"Update a component associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"composite_content_view_id","full_name":"composite_content_view_id","description":"\n\u003cp\u003ecomposite content view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view component ID. Identifier of the component association\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eidentifier of the version of the component content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"latest","full_name":"latest","description":"\n\u003cp\u003etrue if the latest version of the components content view is desired\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"package_groups":{"doc_url":"../apidoc/v2/package_groups","id":"package_groups","api_url":"/api","name":"Package groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/package_groups/index","name":"index","apis":[{"api_url":"/katello/api/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/show","name":"show","apis":[{"api_url":"/katello/api/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/package_groups/:id","http_method":"GET","short_description":"Show a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea package group identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/compare","name":"compare","apis":[{"api_url":"/katello/api/package_groups/compare","http_method":"GET","short_description":"List package_groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/create","name":"create","apis":[{"api_url":"/katello/api/package_group","http_method":"POST","short_description":"Create a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003epackage group description. Defaults to \u003ca href=\":name\"\u003eparams\u003c/a\u003e\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_visible","full_name":"user_visible","description":"\n\u003cp\u003eset “user_visible” flag on package group. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mandatory_package_names","full_name":"mandatory_package_names","description":"\n\u003cp\u003emandatory package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"optional_package_names","full_name":"optional_package_names","description":"\n\u003cp\u003eoptional package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"conditional_package_names","full_name":"conditional_package_names","description":"\n\u003cp\u003econditional package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default_package_names","full_name":"default_package_names","description":"\n\u003cp\u003edefault package names to include in the package group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/package_groups/destroy","name":"destroy","apis":[{"api_url":"/katello/api/package_group","http_method":"DELETE","short_description":"Delete a package group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository_id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filter_rules":{"doc_url":"../apidoc/v2/content_view_filter_rules","id":"content_view_filter_rules","api_url":"/api","name":"Content view filter rules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filter_rules/index","name":"index","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"GET","short_description":"List filter rules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerrata_id of the content view filter rule\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/create","name":"create","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules","http_method":"POST","short_description":"Create a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [String]","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003epackage group: uuid\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eerratum: IDs or a select all object\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"date_type","full_name":"date_type","description":"\n\u003cp\u003eerratum: search using the \u0026#39;Issued On\u0026#39; or \u0026#39;Updated On\u0026#39;\ncolumn of the errata. Values are \u0026#39;issued\u0026#39;/\u0026#39;updated\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"module_stream_ids","full_name":"module_stream_ids","description":"\n\u003cp\u003emodule stream ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/show","name":"show","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"GET","short_description":"Show filter rule info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/update","name":"update","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"PUT","short_description":"Update a filter rule. The parameters included should be based upon the filter type.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003epackage, package group, or docker tag: name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003epackage: version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"\n\u003cp\u003epackage: architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"min_version","full_name":"min_version","description":"\n\u003cp\u003epackage: minimum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"max_version","full_name":"max_version","description":"\n\u003cp\u003epackage: maximum version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"errata_id","full_name":"errata_id","description":"\n\u003cp\u003eerratum: id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eerratum: start date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eerratum: end date (YYYY-MM-DD)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003eerratum: types (enhancement, bugfix, security)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filter_rules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/rules/:id","http_method":"DELETE","short_description":"Delete a filter rule","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003erule identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_filters":{"doc_url":"../apidoc/v2/content_view_filters","id":"content_view_filters","api_url":"/api","name":"Content view filters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_filters/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"get","short_description":"list filters","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"get","short_description":"list filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter content view filters by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"types","full_name":"types","description":"\n\u003cp\u003etypes of filters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_type","values":["rpm","package_group","erratum","docker","modulemd"]},{"name":"inclusion_type","values":["include","exclude"]},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null},{"api_url":"/katello/api/content_view_filters","http_method":"post","short_description":"create a filter for a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the filter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003etype of filter (e.g. rpm, package_group, erratum, docker, modulemd)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package\nfilter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list.\n(module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default:\ninclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"get","short_description":"show filter info","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"get","short_description":"show filter info","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"put","short_description":"update a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"put","short_description":"update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003enew name for the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_packages","full_name":"original_packages","description":"\n\u003cp\u003eadd all packages without errata to the included/excluded list. (package\nfilter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"original_module_streams","full_name":"original_module_streams","description":"\n\u003cp\u003eadd all module streams without errata to the included/excluded list.\n(module stream filter only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"inclusion","full_name":"inclusion","description":"\n\u003cp\u003especifies if content should be included or excluded, default:\ninclusion=false\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003elist of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the filter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_filters/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null},{"api_url":"/katello/api/content_view_filters/:id","http_method":"delete","short_description":"delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003efilter identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"sync":{"doc_url":"../apidoc/v2/sync","id":"sync","api_url":"/api","name":"Sync","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/sync/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/products/:product_id/sync","http_method":"GET","short_description":"Get status of repo synchronisation for given product","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/sync","http_method":"GET","short_description":"Get status of synchronisation for given repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_histories":{"doc_url":"../apidoc/v2/content_view_histories","id":"content_view_histories","api_url":"/api","name":"Content view histories","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_histories/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:id/history","http_method":"GET","short_description":"Show a content view's history","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products_bulk_actions":{"doc_url":"../apidoc/v2/products_bulk_actions","id":"products_bulk_actions","api_url":"/api","name":"Products bulk actions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products_bulk_actions/destroy_products","name":"destroy_products","apis":[{"api_url":"/katello/api/products/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/sync_products","name":"sync_products","apis":[{"api_url":"/katello/api/products/bulk/sync","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"skip_metadata_check","full_name":"skip_metadata_check","description":"\n\u003cp\u003eForce sync even if no upstream changes are detected. Non-yum repositories\nare skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"validate_contents","full_name":"validate_contents","description":"\n\u003cp\u003eForce a sync and validate the checksums of all content. Non-yum\nrepositories (or those with \nOn Demand download policy) are skipped.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_http_proxy","name":"update_http_proxy","apis":[{"api_url":"/katello/api/products/bulk/http_proxy","http_method":"PUT","short_description":"Update the HTTP proxy configuration on the repositories of one or more products.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_policy","full_name":"http_proxy_policy","description":"\n\u003cp\u003epolicy for HTTP proxy for content sync\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eglobal_default_http_proxy\u003c/code\u003e, \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003euse_selected_http_proxy\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy_id","full_name":"http_proxy_id","description":"\n\u003cp\u003eHTTP Proxy identifier to associated\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products_bulk_actions/update_sync_plans","name":"update_sync_plans","apis":[{"api_url":"/katello/api/products/bulk/sync_plan","http_method":"PUT","short_description":"Sync one or more products","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eList of product ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"plan_id","full_name":"plan_id","description":"\n\u003cp\u003eSync plan identifier to attach\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_view_puppet_modules":{"doc_url":"../apidoc/v2/content_view_puppet_modules","id":"content_view_puppet_modules","api_url":"/api","name":"Content view puppet modules","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_puppet_modules/index","name":"index","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"GET","short_description":"List content view puppet modules","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003euuid of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"author","type":"string"},{"name":"content_view_name","type":"string"},{"name":"name","type":"string"},{"name":"uuid","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/create","name":"create","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules","http_method":"POST","short_description":"Add a puppet module to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ethe id of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"GET","short_description":"Show a content view puppet module","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"PUT","short_description":"Update a puppet module associated with the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"author","full_name":"author","description":"\n\u003cp\u003eauthor of the puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"uuid","description":"\n\u003cp\u003ethe uuid of the puppet module to associate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_puppet_modules/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:content_view_id/content_view_puppet_modules/:id","http_method":"DELETE","short_description":"Remove a puppet module from the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003econtent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003epuppet module ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"products":{"doc_url":"../apidoc/v2/products","id":"products","api_url":"/api","name":"Products","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/products/index","name":"index","apis":[{"api_url":"/katello/api/products","http_method":"GET","short_description":"List products","deprecated":null},{"api_url":"/katello/api/subscriptions/:subscription_id/products","http_method":"GET","short_description":"List of subscription products in a subscription","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/products","http_method":"GET","short_description":"List of subscription products in an activation key","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/products","http_method":"GET","short_description":"List of products in an organization","deprecated":null},{"api_url":"/katello/api/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/sync_plans/:sync_plan_id/products","http_method":"GET","short_description":"List of Products for sync plan","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eFilter products by organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subscription_id","full_name":"subscription_id","description":"\n\u003cp\u003eFilter products by subscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eFilter products by name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eReturn enabled products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"custom","full_name":"custom","description":"\n\u003cp\u003eReturn custom products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"redhat_only","full_name":"redhat_only","description":"\n\u003cp\u003eReturn Red Hat (non-custom) products only\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"include_available_content","full_name":"include_available_content","description":"\n\u003cp\u003eWhether to include available content attribute in results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003eFilter products by sync plan id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Products that can be associated\nwith specified object. Only \u0026#39;sync_plan\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"},{"name":"redhat","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/create","name":"create","apis":[{"api_url":"/katello/api/products","http_method":"POST","short_description":"Create a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/show","name":"show","apis":[{"api_url":"/katello/api/products/:id","http_method":"GET","short_description":"Show a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/update","name":"update","apis":[{"api_url":"/katello/api/products/:id","http_method":"PUT","short_description":"Updates a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eProduct description\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gpg_key_id","full_name":"gpg_key_id","description":"\n\u003cp\u003eIdentifier of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_ca_cert_id","full_name":"ssl_ca_cert_id","description":"\n\u003cp\u003eIdenifier of the SSL CA Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_cert_id","full_name":"ssl_client_cert_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Cert\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ssl_client_key_id","full_name":"ssl_client_key_id","description":"\n\u003cp\u003eIdentifier of the SSL Client Key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"sync_plan_id","full_name":"sync_plan_id","description":"\n\u003cp\u003ePlan numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eProduct name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/destroy","name":"destroy","apis":[{"api_url":"/katello/api/products/:id","http_method":"DELETE","short_description":"Destroy a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct numeric identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/products/sync","name":"sync","apis":[{"api_url":"/katello/api/products/:id/sync","http_method":"POST","short_description":"Sync all repositories for a product","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eproduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"content_view_versions":{"doc_url":"../apidoc/v2/content_view_versions","id":"content_view_versions","api_url":"/api","name":"Content view versions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_view_versions/index","name":"index","apis":[{"api_url":"/katello/api/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/content_view_versions","http_method":"GET","short_description":"List content view versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eFilter versions by environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_module_id","full_name":"puppet_module_id","description":"\n\u003cp\u003eFilter versions by puppet module\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003eFilter versions by version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"composite_version_id","full_name":"composite_version_id","description":"\n\u003cp\u003eFilter versions that are components in the specified composite version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"triggered_by_id","full_name":"triggered_by_id","description":"\n\u003cp\u003eFilter composite versions whose publish was triggered by the specified\ncomponent version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"repository","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/show","name":"show","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"GET","short_description":"Show content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/promote","name":"promote","apis":[{"api_url":"/katello/api/content_view_versions/:id/promote","http_method":"POST","short_description":"Promote a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"force","full_name":"force","description":"\n\u003cp\u003eforce content view promotion and bypass lifecycle environment restriction\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eIdentifiers for Lifecycle Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version promotion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/update","name":"update","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"PUT","short_description":"Update a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the content view version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/republish_repositories","name":"republish_repositories","apis":[{"api_url":"/katello/api/content_view_versions/:id/republish_repositories","http_method":"PUT","short_description":"Forces a republish of the version's repositories' metadata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/export_histories","name":"export_histories","apis":[{"api_url":"/katello/api/content_view_versions/export_histories","http_method":"GET","short_description":"Show the export history for a content view version","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":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_view_id","type":"integer"},{"name":"content_view_version_id","type":"integer"},{"name":"id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/export","name":"export","apis":[{"api_url":"/katello/api/content_view_versions/:id/export","http_method":"POST","short_description":"Export a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"destination_server","full_name":"destination_server","description":"\n\u003cp\u003eDestination Server name, required for Pulp3\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"export_to_iso","full_name":"export_to_iso","description":"\n\u003cp\u003eExport to ISO format. Relevant only for Pulp 2 repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"iso_mb_size","full_name":"iso_mb_size","description":"\n\u003cp\u003emaximum size of each ISO in MB. Relevant only for Pulp 2 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":[]},{"name":"since","full_name":"since","description":"\n\u003cp\u003eOptional date of last export (ex: 2010-01-01T12:00:00Z). Relevant only for\nPulp 2 repositories\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Date","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/import","name":"import","apis":[{"api_url":"/katello/api/content_view_versions/import","http_method":"POST","short_description":"Import a content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"path","description":"\n\u003cp\u003eImport path\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_view_versions/:id","http_method":"DELETE","short_description":"Remove content view version","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_view_versions/incremental_update","name":"incremental_update","apis":[{"api_url":"/katello/api/content_view_versions/incremental_update","http_method":"POST","short_description":"Perform an Incremental Update on one or more Content View Versions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_environments","full_name":"content_view_version_environments","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_view_version_id","full_name":"content_view_version_environments[content_view_version_id]","description":"\n\u003cp\u003eContent View Version Ids to perform an incremental update on. May contain\ncomposites as well as one or more components to update.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"content_view_version_environments[environment_ids]","description":"\n\u003cp\u003eThe list of environments to promote the specified Content View Version to\n(replacing the older version)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eThe description for the new generated Content View Versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resolve_dependencies","full_name":"resolve_dependencies","description":"\n\u003cp\u003eIf true, when adding the specified errata or packages, any needed\ndependencies will be copied as well. Defaults to true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"propagate_all_composites","full_name":"propagate_all_composites","description":"\n\u003cp\u003eIf true, will publish a new composite version using any specified\ncontent_view_version_id that has been promoted to a lifecycle environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"add_content","full_name":"add_content","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"errata_ids","full_name":"add_content[errata_ids]","description":"\n\u003cp\u003eErrata ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"package_ids","full_name":"add_content[package_ids]","description":"\n\u003cp\u003ePackage ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"deb_ids","full_name":"add_content[deb_ids]","description":"\n\u003cp\u003eDeb Package ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"puppet_module_ids","full_name":"add_content[puppet_module_ids]","description":"\n\u003cp\u003ePuppet Module ids to copy into the new versions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"update_hosts","full_name":"update_hosts","description":"\n\u003cp\u003eAfter generating the incremental update, apply the changes to the specified\nhosts. Only Errata are supported currently.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"included","full_name":"update_hosts[included]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"update_hosts[included][search]","description":"\n\u003cp\u003eSearch string for host to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"update_hosts[included][ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"update_hosts[excluded]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"update_hosts[excluded][ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"content_views":{"doc_url":"../apidoc/v2/content_views","id":"content_views","api_url":"/api","name":"Content views","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/content_views/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"GET","short_description":"List content views","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"GET","short_description":"List content views","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"nondefault","full_name":"nondefault","description":"\n\u003cp\u003eFilter out default content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"noncomposite","full_name":"noncomposite","description":"\n\u003cp\u003eFilter out composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eFilter only composite content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"without","full_name":"without","description":"\n\u003cp\u003eDo not include this array of content views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"composite","type":"boolean"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/create","name":"create","apis":[{"api_url":"/katello/api/organizations/:organization_id/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null},{"api_url":"/katello/api/content_views","http_method":"POST","short_description":"Create a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eName of the content view\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003eContent view label\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"composite","full_name":"composite","description":"\n\u003cp\u003eComposite content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/update","name":"update","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"PUT","short_description":"Update a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew name for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the content view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"repository_ids","full_name":"repository_ids","description":"\n\u003cp\u003eList of repository ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"component_ids","full_name":"component_ids","description":"\n\u003cp\u003eList of component content view version ids for composite views\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"auto_publish","full_name":"auto_publish","description":"\n\u003cp\u003eEnable/Disable auto publish of composite view\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"solve_dependencies","full_name":"solve_dependencies","description":"\n\u003cp\u003eSolve RPM dependencies by default on Content View publish, defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/publish","name":"publish","apis":[{"api_url":"/katello/api/content_views/:id/publish","http_method":"POST","short_description":"Publish a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003eDescription for the new published content view version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"major","description":"\n\u003cp\u003eOverride the major version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"minor","description":"\n\u003cp\u003eOverride the minor version number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repos_units","full_name":"repos_units","description":"\n\u003cp\u003eSpecify the list of units in each repo\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"label","full_name":"repos_units[label]","description":"\n\u003cp\u003erepo label\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rpm_filenames","full_name":"repos_units[rpm_filenames]","description":"\n\u003cp\u003elist of rpm filename strings to include in published version\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of String","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/show","name":"show","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"GET","short_description":"Show a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_modules","name":"available_puppet_modules","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_modules","http_method":"GET","short_description":"Get puppet modules that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003emodule name to restrict modules for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/available_puppet_module_names","name":"available_puppet_module_names","apis":[{"api_url":"/katello/api/content_views/:id/available_puppet_module_names","http_method":"GET","short_description":"Get puppet modules names that are available to be added to the content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove_from_environment","name":"remove_from_environment","apis":[{"api_url":"/katello/api/content_views/:id/environments/:environment_id","http_method":"DELETE","short_description":"Remove a content view from an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/remove","name":"remove","apis":[{"api_url":"/katello/api/content_views/:id/remove","http_method":"PUT","short_description":"Remove versions and/or environments from a content view and reassign systems and keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"environment_ids","description":"\n\u003cp\u003eenvironment numeric identifiers to be removed\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view version identifiers to be deleted\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"system_content_view_id","full_name":"system_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"system_environment_id","full_name":"system_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned systems to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"key_content_view_id","full_name":"key_content_view_id","description":"\n\u003cp\u003econtent view to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"key_environment_id","full_name":"key_environment_id","description":"\n\u003cp\u003eenvironment to reassign orphaned activation keys to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/destroy","name":"destroy","apis":[{"api_url":"/katello/api/content_views/:id","http_method":"DELETE","short_description":"Delete a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003econtent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/content_views/copy","name":"copy","apis":[{"api_url":"/katello/api/content_views/:id/copy","http_method":"POST","short_description":"Make copy of a content view","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent view numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew content view name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"debs":{"doc_url":"../apidoc/v2/debs","id":"debs","api_url":"/api","name":"Deb Packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/debs/index","name":"index","apis":[{"api_url":"/katello/api/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/debs","http_method":"GET","short_description":"List debs","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs","http_method":"GET","short_description":"List debs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/debs/show","name":"show","apis":[{"api_url":"/katello/api/debs/:id","http_method":"GET","short_description":"Show a deb","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/debs/:id","http_method":"GET","short_description":"Show a deb","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea deb identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/debs/compare","name":"compare","apis":[{"api_url":"/katello/api/debs/compare","http_method":"GET","short_description":"List debs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"docker_manifest_lists":{"doc_url":"../apidoc/v2/docker_manifest_lists","id":"docker_manifest_lists","api_url":"/api","name":"Docker manifest lists","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifest_lists/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifest_lists/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifest_lists/:id","http_method":"GET","short_description":"Show a docker manifest list","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest list identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifest_lists/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifest_lists/compare","http_method":"GET","short_description":"List docker_manifest_lists","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_manifests":{"doc_url":"../apidoc/v2/docker_manifests","id":"docker_manifests","api_url":"/api","name":"Docker manifests","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_manifests/index","name":"index","apis":[{"api_url":"/katello/api/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/show","name":"show","apis":[{"api_url":"/katello/api/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_manifests/:id","http_method":"GET","short_description":"Show a docker manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker manifest identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_manifests/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_manifests/compare","http_method":"GET","short_description":"List docker_manifests","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"docker_tags":{"doc_url":"../apidoc/v2/docker_tags","id":"docker_tags","api_url":"/api","name":"Docker tags","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/docker_tags/index","name":"index","apis":[{"api_url":"/katello/api/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/show","name":"show","apis":[{"api_url":"/katello/api/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/docker_tags/:id","http_method":"GET","short_description":"Show a docker tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea docker tag identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/compare","name":"compare","apis":[{"api_url":"/katello/api/docker_tags/compare","http_method":"GET","short_description":"List docker_tags","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/docker_tags/repositories","name":"repositories","apis":[{"api_url":"/katello/api/docker_tags/:id/repositories","http_method":"GET","short_description":"List of repositories for a docker meta tag","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"lifecycle_environments":{"doc_url":"../apidoc/v2/lifecycle_environments","id":"lifecycle_environments","api_url":"/api","name":"Lifecycle environments","short_description":null,"full_description":"\n\u003cp\u003e# Description\u003c/p\u003e\n\n\u003cp\u003eAn environment is a basic organization structure that groups hosts,\nproducts, repositories, etc. Every host belongs to one environment and\nit\u0026#39;s isolated inside so that it can see only content that is in its\nenvironment.\u003c/p\u003e\n\n\u003cp\u003e## Chains\u003c/p\u003e\n\n\u003cp\u003eEnvironments are ordered into chains and their content (products,\nrepositories, tempaltes, packages) can be moved to an environment only from\nits prior environment. You can have for example chain like:\u003c/p\u003e\n\n\u003cpre\u003eLibrary -\u0026gt; Development -\u0026gt; Testing -\u0026gt; Production\u003c/pre\u003e\n\n\u003cp\u003eEach change in an environment is done through a changeset in an action\ncalled promotion.\u003c/p\u003e\n\n\u003cp\u003e## Library\u003c/p\u003e\n\n\u003cp\u003eLibrary is a special environment that has no ascendant: All the content\nstarts in this environment. More chains can start from the library\nenvironment but no further branching of a chain is enabled.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/lifecycle_environments/index","name":"index","apis":[{"api_url":"/katello/api/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"library","full_name":"library","description":"\n\u003cp\u003eset true if you want to see only library environments\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003efilter only environments containing this name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"id","type":"integer"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/show","name":"show","apis":[{"api_url":"/katello/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:environment_id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/create","name":"create","apis":[{"api_url":"/katello/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments","http_method":"POST","short_description":"Create an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"label","full_name":"label","description":"\n\u003cp\u003elabel of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"prior_id","full_name":"prior_id","description":"\n\u003cp\u003eID of an environment that is prior to the new environment in the chain. It\nhas to be either the ID of Library or the ID of an environment at the end\nof a chain.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/update","name":"update","apis":[{"api_url":"/katello/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"PUT","short_description":"Update an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003ename of the organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"new_name","full_name":"new_name","description":"\n\u003cp\u003enew name to be given to the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n\u003cp\u003edescription of the environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_name_pattern","full_name":"registry_name_pattern","description":"\n\u003cp\u003epattern for container image names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"registry_unauthenticated_pull","full_name":"registry_unauthenticated_pull","description":"\n\u003cp\u003eallow unauthenticed pull of container images\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"async","full_name":"async","description":"\n\u003cp\u003eDo not wait for the update action to finish. Default: true\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/destroy","name":"destroy","apis":[{"api_url":"/katello/api/environments/:id","http_method":"DELETE","short_description":"Destroy an environment","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/environments/:id","http_method":"DELETE","short_description":"Destroy an environment in an organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the environment\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/lifecycle_environments/paths","name":"paths","apis":[{"api_url":"/katello/api/organizations/:organization_id/environments/paths","http_method":"GET","short_description":"List environment paths","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"permission_type","full_name":"permission_type","description":"\n\u003cp\u003eThe associated permission type. One of (readable | promotable) Default:\nreadable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"errata":{"doc_url":"../apidoc/v2/errata","id":"errata","api_url":"/api","name":"Errata","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/errata/index","name":"index","apis":[{"api_url":"/katello/api/errata","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eReturn errata that can be added to the specified object. The values\n\u0026#39;content_view_version\u0026#39; and \u0026#39;content_view_filter are supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"bug","type":"string"},{"name":"cve","type":"string"},{"name":"errata_id","type":"string"},{"name":"errata_type","type":"string"},{"name":"id","type":"string"},{"name":"issued","type":"date"},{"name":"modular","values":["true","false"]},{"name":"package","type":"string"},{"name":"package_name","type":"string"},{"name":"reboot_suggested","type":"boolean"},{"name":"repository","type":"string"},{"name":"severity","type":"string"},{"name":"title","type":"string"},{"name":"type","type":"string"},{"name":"updated","type":"date"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/show","name":"show","apis":[{"api_url":"/katello/api/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/errata/:id","http_method":"GET","short_description":"Show an erratum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean erratum identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/compare","name":"compare","apis":[{"api_url":"/katello/api/errata/compare","http_method":"GET","short_description":"List errata","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/errata/available_errata","name":"available_errata","apis":[{"api_url":"/katello/api/content_view_versions/:id/available_errata","http_method":"GET","short_description":"Return errata that can be added to the Content View Version via an Incremental Update","deprecated":true}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003eContent View Filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"cve","full_name":"cve","description":"\n\u003cp\u003eCVE identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost id to list applicable errata for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_applicable","full_name":"errata_restrict_applicable","description":"\n\u003cp\u003eReturn errata that are applicable to one or more hosts (defaults to true if\nhost_id is specified)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"errata_restrict_installable","full_name":"errata_restrict_installable","description":"\n\u003cp\u003eReturn errata that are upgradable on one or more hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"file_units":{"doc_url":"../apidoc/v2/file_units","id":"file_units","api_url":"/api","name":"Files","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/file_units/index","name":"index","apis":[{"api_url":"/katello/api/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/files","http_method":"GET","short_description":"List files","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/file_units/show","name":"show","apis":[{"api_url":"/katello/api/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/files/:id","http_method":"GET","short_description":"Show a file","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea file identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/file_units/compare","name":"compare","apis":[{"api_url":"/katello/api/files/compare","http_method":"GET","short_description":"List files","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"gpg_keys":{"doc_url":"../apidoc/v2/gpg_keys","id":"gpg_keys","api_url":"/api","name":"Gpg keys","short_description":null,"full_description":"\n\u003cp\u003e# Description Documents the calls for the list, read, create, update and\ndelete operations for GPG keys\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/gpg_keys/index","name":"index","apis":[{"api_url":"/katello/api/gpg_keys","http_method":"GET","short_description":"List gpg keys","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the GPG key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/create","name":"create","apis":[{"api_url":"/katello/api/gpg_keys","http_method":"POST","short_description":"Create a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the gpg key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/show","name":"show","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"GET","short_description":"Show a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/update","name":"update","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"PUT","short_description":"Update a repository","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eidentifier of the gpg key\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003epublic key block in DER encoding\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/destroy","name":"destroy","apis":[{"api_url":"/katello/api/gpg_keys/:id","http_method":"DELETE","short_description":"Destroy a gpg key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/content","name":"content","apis":[{"api_url":"/katello/api/gpg_keys/:id/content","http_method":"GET","short_description":"Return the content of a gpg key, used directly by yum","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/gpg_keys/set_content","name":"set_content","apis":[{"api_url":"/katello/api/gpg_keys/:id/content","http_method":"POST","short_description":"Upload gpg key contents","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003egpg key numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003efile contents\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_collections":{"doc_url":"../apidoc/v2/host_collections","id":"host_collections","api_url":"/api","name":"Host collections","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_collections/show","name":"show","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"GET","short_description":"Show a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/index","name":"index","apis":[{"api_url":"/katello/api/host_collections","http_method":"GET","short_description":"List host collections","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"GET","short_description":"List host collections within an organization","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/host_collections","http_method":"GET","short_description":"List host collections in an activation key","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehost collection name to filter by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eactivation key identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eFilter products by host id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eInterpret specified object to return only Host Collections that can be\nassociated with specified object. The value \u0026#39;host\u0026#39; is supported.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"host","type":"string"},{"name":"name","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/create","name":"create","apis":[{"api_url":"/katello/api/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null},{"api_url":"/katello/api/organizations/:organization_id/host_collections","http_method":"POST","short_description":"Create a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/update","name":"update","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"PUT","short_description":"Update a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eHost Collection name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host ids to replace the hosts in host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"max_hosts","full_name":"max_hosts","description":"\n\u003cp\u003eMaximum number of hosts in the host collection\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"unlimited_hosts","full_name":"unlimited_hosts","description":"\n\u003cp\u003eWhether or not the host collection may have unlimited hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/add_hosts","name":"add_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/add_hosts","http_method":"PUT","short_description":"Add host to the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/remove_hosts","name":"remove_hosts","apis":[{"api_url":"/katello/api/host_collections/:id/remove_hosts","http_method":"PUT","short_description":"Remove hosts from the host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eArray of host ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/destroy","name":"destroy","apis":[{"api_url":"/katello/api/host_collections/:id","http_method":"DELETE","short_description":"Destroy a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eId of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_collections/copy","name":"copy","apis":[{"api_url":"/katello/api/host_collections/:id/copy","http_method":"POST","short_description":"Make copy of a host collection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the host collection\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eNew host collection name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_debs":{"doc_url":"../apidoc/v2/host_debs","id":"host_debs","api_url":"/api","name":"Host debs","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_debs/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/debs","http_method":"GET","short_description":"List deb packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_errata":{"doc_url":"../apidoc/v2/host_errata","id":"host_errata","api_url":"/api","name":"Host errata","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_errata/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/errata","http_method":"GET","short_description":"List errata available for the content host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eUUID of the content host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Content View\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eCalculate Applicable Errata based on a particular Environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/apply","name":"apply","apis":[{"api_url":"/api/hosts/:host_id/errata/apply","http_method":"PUT","short_description":"Schedule errata for installation","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids to install\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"\n\u003cp\u003eErrata to exclusively include in the action\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for erratum to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of errata ids to perform an action on, (ex: RHSA-2019:1168)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"\n\u003cp\u003eErrata to explicitly exclude in the action. All other applicable errata\nwill be included in the action, unless an included parameter is passed as\nwell.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of errata ids to exclude and not run an action on, (ex:\nRHSA-2019:1168)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/errata/:id","http_method":"GET","short_description":"Retrieve a single errata for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eErrata id of the erratum (RHSA-2012:108)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_errata/applicability","name":"applicability","apis":[{"api_url":"/api/hosts/:host_id/errata/applicability","http_method":"PUT","short_description":"Force regenerate applicability.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eHost ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_module_streams":{"doc_url":"../apidoc/v2/host_module_streams","id":"host_module_streams","api_url":"/api","name":"Host module streams","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_module_streams/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/module_streams","http_method":"GET","short_description":"List module streams available to the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eStreams based on the host based on their status\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eenabled\u003c/code\u003e, \u003ccode\u003edisabled\u003c/code\u003e, \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003einstalled\u003c/code\u003e, \u003ccode\u003eupgradable\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_packages":{"doc_url":"../apidoc/v2/host_packages","id":"host_packages","api_url":"/api","name":"Host packages","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_packages/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/packages","http_method":"GET","short_description":"List packages installed on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"arch","type":"string"},{"name":"epoch","type":"string"},{"name":"name","type":"string"},{"name":"nvra","type":"string"},{"name":"nvrea","type":"string"},{"name":"release","type":"string"},{"name":"version","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/install","name":"install","apis":[{"api_url":"/api/hosts/:host_id/packages/install","http_method":"PUT","short_description":"Install packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade","name":"upgrade","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003elist of packages names\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/upgrade_all","name":"upgrade_all","apis":[{"api_url":"/api/hosts/:host_id/packages/upgrade_all","http_method":"PUT","short_description":"Update packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_packages/remove","name":"remove","apis":[{"api_url":"/api/hosts/:host_id/packages/remove","http_method":"PUT","short_description":"Uninstall packages remotely","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"packages","full_name":"packages","description":"\n\u003cp\u003eList of package names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"groups","full_name":"groups","description":"\n\u003cp\u003eList of package group names\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"host_tracer":{"doc_url":"../apidoc/v2/host_tracer","id":"host_tracer","api_url":"/api","name":"Host tracer","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_tracer/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/traces","http_method":"GET","short_description":"List services that need restarting on the host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_tracer/resolve","name":"resolve","apis":[{"api_url":"/api/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":[]},{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"hosts_bulk_actions":{"doc_url":"../apidoc/v2/hosts_bulk_actions","id":"hosts_bulk_actions","api_url":"/api","name":"Hosts bulk actions","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_add_host_collections","name":"bulk_add_host_collections","apis":[{"api_url":"/api/hosts/bulk/add_host_collections","http_method":"PUT","short_description":"Add one or more host collections to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/bulk_remove_host_collections","name":"bulk_remove_host_collections","apis":[{"api_url":"/api/hosts/bulk/remove_host_collections","http_method":"PUT","short_description":"Remove one or more host collections from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"host_collection_ids","full_name":"host_collection_ids","description":"\n\u003cp\u003eList of host collection ids\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/applicable_errata","name":"applicable_errata","apis":[{"api_url":"/api/hosts/bulk/applicable_errata","http_method":"POST","short_description":"Fetch applicable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/installable_errata","name":"installable_errata","apis":[{"api_url":"/api/hosts/bulk/installable_errata","http_method":"POST","short_description":"Fetch installable errata for one or more hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/install_content","name":"install_content","apis":[{"api_url":"/api/hosts/bulk/install_content","http_method":"PUT","short_description":"Install content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;,\n\u0026#39;package_group\u0026#39; and \u0026#39;errata\u0026#39;.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package names, package group names or errata ids)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/update_content","name":"update_content","apis":[{"api_url":"/api/hosts/bulk/update_content","http_method":"PUT","short_description":"Update content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;\nand \u0026#39;package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"update_all","full_name":"update_all","description":"\n\u003cp\u003eUpdates all packages on the host(s)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_content","name":"remove_content","apis":[{"api_url":"/api/hosts/bulk/remove_content","http_method":"PUT","short_description":"Remove content on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_type","full_name":"content_type","description":"\n\u003cp\u003eThe type of content. The following types are supported: \u0026#39;package\u0026#39;\nand \u0026#39;package_group.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eList of content (e.g. package or package group names)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/destroy_hosts","name":"destroy_hosts","apis":[{"api_url":"/api/hosts/bulk/destroy","http_method":"PUT","short_description":"Destroy one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/remove_subscriptions","name":"remove_subscriptions","apis":[{"api_url":"/api/hosts/bulk/remove_subscriptions","http_method":"PUT","short_description":"Remove subscriptions from one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of specified subscription to remove\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/add_subscriptions","name":"add_subscriptions","apis":[{"api_url":"/api/hosts/bulk/add_subscriptions","http_method":"PUT","short_description":"Add subscriptions to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"subscriptions","full_name":"subscriptions","description":"\n\u003cp\u003eArray of subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"subscriptions[id]","description":"\n\u003cp\u003eSubscription Pool id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"quantity","full_name":"subscriptions[quantity]","description":"\n\u003cp\u003eQuantity of this subscriptions to add\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/auto_attach","name":"auto_attach","apis":[{"api_url":"/api/hosts/bulk/auto_attach","http_method":"PUT","short_description":"Trigger an auto-attach of subscriptions on one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/content_overrides","name":"content_overrides","apis":[{"api_url":"/api/hosts/bulk/content_overrides","http_method":"PUT","short_description":"Set content overrides to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"content_overrides","full_name":"content_overrides","description":"\n\u003cp\u003eArray of Content override parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"content_label","full_name":"content_overrides[content_label]","description":"\n\u003cp\u003eLabel of the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"content_overrides[value]","description":"\n\u003cp\u003eOverride value. Provide a boolean value if name is \u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"content_overrides[name]","description":"\n\u003cp\u003eOverride key or name. Note if name is not provided the default name will be\n\u0026#39;enabled\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"remove","full_name":"content_overrides[remove]","description":"\n\u003cp\u003eSet true to remove an override and reset it to \u0026#39;default\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/environment_content_view","name":"environment_content_view","apis":[{"api_url":"/api/hosts/bulk/environment_content_view","http_method":"PUT","short_description":"Assign the environment and content view to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_id","full_name":"content_view_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/release_version","name":"release_version","apis":[{"api_url":"/api/hosts/bulk/release_version","http_method":"PUT","short_description":"Assign the release version to one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"release_version","full_name":"release_version","description":"\n\u003cp\u003econtent release version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/traces","name":"traces","apis":[{"api_url":"/api/hosts/bulk/traces","http_method":"POST","short_description":"Fetch traces for one or more hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/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":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"trace_ids","full_name":"trace_ids","description":"\n\u003cp\u003eArray of Trace IDs\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/available_incremental_updates","name":"available_incremental_updates","apis":[{"api_url":"/api/hosts/bulk/available_incremental_updates","http_method":"POST","short_description":"Given a set of hosts and errata, lists the content view versions and environments that need updating.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"errata_ids","full_name":"errata_ids","description":"\n\u003cp\u003eList of Errata ids\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts_bulk_actions/module_streams","name":"module_streams","apis":[{"api_url":"/api/hosts/bulk/module_streams","http_method":"POST","short_description":"Fetch available module streams for hosts.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the organization\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"included","full_name":"included","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"search","full_name":"included[search]","description":"\n\u003cp\u003eSearch string for hosts to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"included[ids]","description":"\n\u003cp\u003eList of host ids to perform an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"excluded","full_name":"excluded","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"ids","full_name":"excluded[ids]","description":"\n\u003cp\u003eList of host ids to exclude and not run an action on\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"module_streams":{"doc_url":"../apidoc/v2/module_streams","id":"module_streams","api_url":"/api","name":"Module streams","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/module_streams/index","name":"index","apis":[{"api_url":"/katello/api/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"host_ids","description":"\n\u003cp\u003eList of host id to list available module streams for\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"name_stream_only","full_name":"name_stream_only","description":"\n\u003cp\u003eReturn name and stream information only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/module_streams/show","name":"show","apis":[{"api_url":"/katello/api/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/module_streams/:id","http_method":"GET","short_description":"Show a module stream","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ea module stream identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/module_streams/compare","name":"compare","apis":[{"api_url":"/katello/api/module_streams/compare","http_method":"GET","short_description":"List module_streams","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ostree_branches":{"doc_url":"../apidoc/v2/ostree_branches","id":"ostree_branches","api_url":"/api","name":"Ostree branches","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ostree_branches/index","name":"index","apis":[{"api_url":"/katello/api/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/content_views/:content_view_id/filters/:filter_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/content_view_filters/:content_view_filter_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_branches","http_method":"GET","short_description":"List ostree_branches","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003econtent view version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_id","full_name":"content_view_filter_id","description":"\n\u003cp\u003econtent view filter identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_filter_rule_id","full_name":"content_view_filter_rule_id","description":"\n\u003cp\u003econtent view filter rule identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eenvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ids","full_name":"ids","description":"\n\u003cp\u003eids to filter content by\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ostree_branches/show","name":"show","apis":[{"api_url":"/katello/api/ostree_branches/:id","http_method":"GET","short_description":"Show an ostree branch","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/ostree_branches/:id","http_method":"GET","short_description":"Show an ostree branch","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003ean ostree branch identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ostree_branches/compare","name":"compare","apis":[{"api_url":"/katello/api/ostree_branches/compare","http_method":"GET","short_description":"List ostree_branches","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"repository_sets":{"doc_url":"../apidoc/v2/repository_sets","id":"repository_sets","api_url":"/api","name":"Repository sets","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/repository_sets/index","name":"index","apis":[{"api_url":"/katello/api/repository_sets","http_method":"GET","short_description":"List repository sets.","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets","http_method":"GET","short_description":"List repository sets for a product.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003eRepository set name to search on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"enabled","description":"\n\u003cp\u003eIf true, only return repository sets that have been enabled. Defaults to\nfalse\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"with_active_subscription","full_name":"with_active_subscription","description":"\n\u003cp\u003eIf true, only return repository sets that are associated with an active\nsubscriptions\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"with_custom","full_name":"with_custom","description":"\n\u003cp\u003eIf true, return custom repository sets along with redhat repos\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"content_label","type":"string"},{"name":"content_type","type":"string"},{"name":"label","type":"string"},{"name":"name","type":"string"},{"name":"product_id","type":"integer"},{"name":"product_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/show","name":"show","apis":[{"api_url":"/katello/api/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id","http_method":"GET","short_description":"Get info about a repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/available_repositories","name":"available_repositories","apis":[{"api_url":"/katello/api/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/available_repositories","http_method":"GET","short_description":"Get list of available repositories for the repository set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of a product to list repository sets from\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/enable","name":"enable","apis":[{"api_url":"/katello/api/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/enable","http_method":"PUT","short_description":"Enable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to enable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to enable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/repository_sets/disable","name":"disable","apis":[{"api_url":"/katello/api/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null},{"api_url":"/katello/api/products/:product_id/repository_sets/:id/disable","http_method":"PUT","short_description":"Disable a repository from the set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the repository set to disable\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"product_id","full_name":"product_id","description":"\n\u003cp\u003eID of the product containing the repository set\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"basearch","full_name":"basearch","description":"\n\u003cp\u003eBasearch to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"releasever","full_name":"releasever","description":"\n\u003cp\u003eReleasever to disable\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"srpms":{"doc_url":"../apidoc/v2/srpms","id":"srpms","api_url":"/api","name":"Srpms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/srpms/index","name":"index","apis":[{"api_url":"/katello/api/srpms","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eRepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eEnvironment identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content_view_version_id","full_name":"content_view_version_id","description":"\n\u003cp\u003eContent View Version identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/srpms/show","name":"show","apis":[{"api_url":"/katello/api/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null},{"api_url":"/katello/api/repositories/:repository_id/srpms/:id","http_method":"GET","short_description":"Show SRPM details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003erepository identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eorganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSRPM details identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/srpms/compare","name":"compare","apis":[{"api_url":"/katello/api/srpms/compare","http_method":"GET","short_description":"List srpms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"content_view_version_ids","full_name":"content_view_version_ids","description":"\n\u003cp\u003econtent view versions to compare\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"repository_id","full_name":"repository_id","description":"\n\u003cp\u003eLibrary repository id to restrict comparisons to\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"subscriptions":{"doc_url":"../apidoc/v2/subscriptions","id":"subscriptions","api_url":"/api","name":"Subscriptions","short_description":null,"full_description":"\n\u003cp\u003eSubscriptions management.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subscriptions/index","name":"index","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions","http_method":"GET","short_description":"List organization subscriptions","deprecated":null},{"api_url":"/katello/api/activation_keys/:activation_key_id/subscriptions","http_method":"GET","short_description":"List an activation key's subscriptions","deprecated":null},{"api_url":"/katello/api/subscriptions","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"search","full_name":"search","description":"\n\u003cp\u003eSearch string\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. \u0026#39;id DESC\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"full_result","full_name":"full_result","description":"\n\u003cp\u003eWhether or not to show all results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"sort_by","full_name":"sort_by","description":"\n\u003cp\u003eField to sort the results on\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sort_order","full_name":"sort_order","description":"\n\u003cp\u003eHow to order the sorted results (e.g. ASC for ascending)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eid of a host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"activation_key_id","full_name":"activation_key_id","description":"\n\u003cp\u003eActivation key ID\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"available_for","full_name":"available_for","description":"\n\u003cp\u003eObject to show subscriptions available for, either \u0026#39;host\u0026#39; or\n\u0026#39;activation_key\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"match_host","full_name":"match_host","description":"\n\u003cp\u003eIgnore subscriptions that are unavailable to the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"match_installed","full_name":"match_installed","description":"\n\u003cp\u003eReturn subscriptions that match installed products of the specified host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"no_overlap","full_name":"no_overlap","description":"\n\u003cp\u003eReturn subscriptions which do not overlap with a currently-attached\nsubscription\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/show","name":"show","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null},{"api_url":"/katello/api/subscriptions/:id","http_method":"GET","short_description":"Show a subscription","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization identifier\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubscription identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/upload","name":"upload","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/upload","http_method":"POST","short_description":"Upload a subscription manifest","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"content","full_name":"content","description":"\n\u003cp\u003eSubscription manifest file\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"File","expected_type":"file","metadata":null,"show":true,"validations":[]},{"name":"repository_url","full_name":"repository_url","description":"\n\u003cp\u003erepository url\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/refresh_manifest","name":"refresh_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/refresh_manifest","http_method":"PUT","short_description":"Refresh previously imported manifest for Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/delete_manifest","name":"delete_manifest","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/delete_manifest","http_method":"POST","short_description":"Delete manifest from Red Hat provider","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization id\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subscriptions/manifest_history","name":"manifest_history","apis":[{"api_url":"/katello/api/organizations/:organization_id/subscriptions/manifest_history","http_method":"GET","short_description":"obtain manifest history for subscriptions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eOrganization ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}},"link_extension":".html"}} \ No newline at end of file diff --git a/tests/fixtures/apidoc/content_views_role.json b/tests/fixtures/apidoc/content_views_role.json new file mode 120000 index 00000000..8e89899a --- /dev/null +++ b/tests/fixtures/apidoc/content_views_role.json @@ -0,0 +1 @@ +katello.json \ No newline at end of file diff --git a/tests/fixtures/apidoc/organizations_role.json b/tests/fixtures/apidoc/organizations_role.json deleted file mode 100644 index d35ba7b2..00000000 --- a/tests/fixtures/apidoc/organizations_role.json +++ /dev/null @@ -1 +0,0 @@ -{"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":{"template_combinations":{"doc_url":"../apidoc/v2/template_combinations","id":"template_combinations","api_url":"/api","name":"Template combinations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_combinations/index","name":"index","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"GET","short_description":"List template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/create","name":"create","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations","http_method":"POST","short_description":"Add a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/show","name":"show","apis":[{"api_url":"/api/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"GET","short_description":"Show template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:provisioning_template_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null},{"api_url":"/api/environments/:environment_id/template_combinations/:id","http_method":"PUT","short_description":"Update template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of config template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_combination","full_name":"template_combination","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"environment_id","full_name":"template_combination[environment_id]","description":"\n\u003cp\u003eenvironment id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"template_combination[hostgroup_id]","description":"\n\u003cp\u003ehost group id\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_combinations/destroy","name":"destroy","apis":[{"api_url":"/api/template_combinations/:id","http_method":"DELETE","short_description":"Delete a template combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"architectures":{"doc_url":"../apidoc/v2/architectures","id":"architectures","api_url":"/api","name":"Architectures","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/architectures/index","name":"index","apis":[{"api_url":"/api/architectures","http_method":"GET","short_description":"List all architectures","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/architectures","http_method":"GET","short_description":"List all architectures for operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"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 String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/show","name":"show","apis":[{"api_url":"/api/architectures/:id","http_method":"GET","short_description":"Show an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/create","name":"create","apis":[{"api_url":"/api/architectures","http_method":"POST","short_description":"Create an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/update","name":"update","apis":[{"api_url":"/api/architectures/:id","http_method":"PUT","short_description":"Update an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"architecture[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"architecture[operatingsystem_ids]","description":"\n\u003cp\u003eOperating system IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/architectures/destroy","name":"destroy","apis":[{"api_url":"/api/architectures/:id","http_method":"DELETE","short_description":"Delete an architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_inputs":{"doc_url":"../apidoc/v2/template_inputs","id":"template_inputs","api_url":"/api","name":"Template inputs","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_inputs/index","name":"index","apis":[{"api_url":"/api/templates/:template_id/template_inputs","http_method":"GET","short_description":"List template inputs","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"input_type","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/show","name":"show","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"GET","short_description":"Show template input details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/template_inputs/destroy","name":"destroy","apis":[{"api_url":"/api/templates/:template_id/template_inputs/:id","http_method":"DELETE","short_description":"Delete a template input","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"template_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_input","full_name":"template_input","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"template_input[name]","description":"\n\u003cp\u003eInput name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"template_input[description]","description":"\n\u003cp\u003eInput description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"template_input[required]","description":"\n\u003cp\u003eInput is required\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"advanced","full_name":"template_input[advanced]","description":"\n\u003cp\u003eInput is advanced\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"input_type","full_name":"template_input[input_type]","description":"\n\u003cp\u003eInput type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003euser\u003c/code\u003e, \u003ccode\u003efact\u003c/code\u003e, \u003ccode\u003evariable\u003c/code\u003e, \u003ccode\u003epuppet_parameter\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fact_name","full_name":"template_input[fact_name]","description":"\n\u003cp\u003eFact name, used when input type is fact\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"variable_name","full_name":"template_input[variable_name]","description":"\n\u003cp\u003eVariable name, used when input type is variable\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_class_name","full_name":"template_input[puppet_class_name]","description":"\n\u003cp\u003ePuppet class name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppet_parameter_name","full_name":"template_input[puppet_parameter_name]","description":"\n\u003cp\u003ePuppet parameter name, used when input type is puppet_parameter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"options","full_name":"template_input[options]","description":"\n\u003cp\u003eSelectable values for user inputs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"template_input[default]","description":"\n\u003cp\u003eDefault value for user input\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"template_input[hidden_value]","description":"\n\u003cp\u003eThe value contains sensitive information and shouldn not be normally\nvisible, useful e.g. for passwords\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"value_type","full_name":"template_input[value_type]","description":"\n\u003cp\u003eValue type, defaults to plain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eplain\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, \u003ccode\u003edate\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"resource_type","full_name":"template_input[resource_type]","description":"\n\u003cp\u003eFor values of type search, this is the resource the value searches in\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eArchitecture\u003c/code\u003e, \u003ccode\u003eAudit\u003c/code\u003e, \u003ccode\u003eAuthSource\u003c/code\u003e, \u003ccode\u003eBookmark\u003c/code\u003e, \u003ccode\u003eComputeProfile\u003c/code\u003e, \u003ccode\u003eComputeResource\u003c/code\u003e, \u003ccode\u003eConfigGroup\u003c/code\u003e, \u003ccode\u003eConfigReport\u003c/code\u003e, \u003ccode\u003eDomain\u003c/code\u003e, \u003ccode\u003eEnvironment\u003c/code\u003e, \u003ccode\u003eExternalUsergroup\u003c/code\u003e, \u003ccode\u003eFactValue\u003c/code\u003e, \u003ccode\u003eFilter\u003c/code\u003e, \u003ccode\u003eHost\u003c/code\u003e, \u003ccode\u003eHostClass\u003c/code\u003e, \u003ccode\u003eHostgroup\u003c/code\u003e, \u003ccode\u003eHttpProxy\u003c/code\u003e, \u003ccode\u003eImage\u003c/code\u003e, \u003ccode\u003eKeyPair\u003c/code\u003e, \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eMailNotification\u003c/code\u003e, \u003ccode\u003eMedium\u003c/code\u003e, \u003ccode\u003eModel\u003c/code\u003e, \u003ccode\u003eOperatingsystem\u003c/code\u003e, \u003ccode\u003eOrganization\u003c/code\u003e, \u003ccode\u003eParameter\u003c/code\u003e, \u003ccode\u003ePersonalAccessToken\u003c/code\u003e, \u003ccode\u003eProvisioningTemplate\u003c/code\u003e, \u003ccode\u003ePtable\u003c/code\u003e, \u003ccode\u003ePuppetclass\u003c/code\u003e, \u003ccode\u003ePuppetclassLookupKey\u003c/code\u003e, \u003ccode\u003eRealm\u003c/code\u003e, \u003ccode\u003eReport\u003c/code\u003e, \u003ccode\u003eReportTemplate\u003c/code\u003e, \u003ccode\u003eRole\u003c/code\u003e, \u003ccode\u003eSetting\u003c/code\u003e, \u003ccode\u003eSmartProxy\u003c/code\u003e, \u003ccode\u003eSshKey\u003c/code\u003e, \u003ccode\u003eSubnet\u003c/code\u003e, \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"audits":{"doc_url":"../apidoc/v2/audits","id":"audits","api_url":"/api","name":"Audits","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/audits/index","name":"index","apis":[{"api_url":"/api/audits","http_method":"GET","short_description":"List all audits","deprecated":null},{"api_url":"/api/hosts/:host_id/audits","http_method":"GET","short_description":"List all audits for a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"action","type":"string"},{"name":"auditable_id","type":"integer"},{"name":"changes","type":"text"},{"name":"comment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"id","type":"integer"},{"name":"interface_fqdn","type":"string"},{"name":"interface_ip","type":"string"},{"name":"interface_mac","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_title","type":"string"},{"name":"parameter","type":"string"},{"name":"partition_table","type":"string"},{"name":"provisioning_template","type":"string"},{"name":"puppetclass","type":"string"},{"name":"remote_address","type":"string"},{"name":"request_uuid","type":"string"},{"name":"setting","type":"string"},{"name":"time","type":"datetime"},{"name":"type","values":["operatingsystem","role","ptable","provisioning_template","user","auth_source","compute_resource","host","interface","location","organization","os","override_value","parameter","partition_table","setting","smart_class_parameter","subnet"]},{"name":"user","type":"string"},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/audits/show","name":"show","apis":[{"api_url":"/api/audits/:id","http_method":"GET","short_description":"Show an audit","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"personal_access_tokens":{"doc_url":"../apidoc/v2/personal_access_tokens","id":"personal_access_tokens","api_url":"/api","name":"Personal access tokens","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/personal_access_tokens/index","name":"index","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"GET","short_description":"List all Personal Access Tokens for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/show","name":"show","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"GET","short_description":"Show a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/create","name":"create","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens","http_method":"POST","short_description":"Create a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"personal_access_token","full_name":"personal_access_token","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"personal_access_token[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"expires_at","full_name":"personal_access_token[expires_at]","description":"\n\u003cp\u003eExpiry Date\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a DateTime","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/personal_access_tokens/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/personal_access_tokens/:id","http_method":"DELETE","short_description":"Revoke a Personal Access Token for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_externals":{"doc_url":"../apidoc/v2/auth_source_externals","id":"auth_source_externals","api_url":"/api","name":"Auth source externals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_externals/index","name":"index","apis":[{"api_url":"/api/auth_source_externals","http_method":"GET","short_description":"List external authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_externals","http_method":"GET","short_description":"List external authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_externals/show","name":"show","apis":[{"api_url":"/api/auth_source_externals/:id","http_method":"GET","short_description":"Show an external authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_external","full_name":"auth_source_external","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_external[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_external[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_external[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ping":{"doc_url":"../apidoc/v2/ping","id":"ping","api_url":"/api","name":"Ping","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ping/ping","name":"ping","apis":[{"api_url":"/api/ping","http_method":"GET","short_description":"Shows status of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is available for unauthenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ping/statuses","name":"statuses","apis":[{"api_url":"/api/statuses","http_method":"GET","short_description":"Shows status and version information of Foreman system and it's subcomponents","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThis service is only available for authenticated users\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"auth_source_internals":{"doc_url":"../apidoc/v2/auth_source_internals","id":"auth_source_internals","api_url":"/api","name":"Auth source internals","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_internals/index","name":"index","apis":[{"api_url":"/api/auth_source_internals","http_method":"GET","short_description":"List internal authentication sources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_internals/show","name":"show","apis":[{"api_url":"/api/auth_source_internals/:id","http_method":"GET","short_description":"Show an internal authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"plugins":{"doc_url":"../apidoc/v2/plugins","id":"plugins","api_url":"/api","name":"Plugins","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/plugins/index","name":"index","apis":[{"api_url":"/api/plugins","http_method":"GET","short_description":"List installed plugins","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_source_ldaps":{"doc_url":"../apidoc/v2/auth_source_ldaps","id":"auth_source_ldaps","api_url":"/api","name":"Auth source ldaps","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_source_ldaps/index","name":"index","apis":[{"api_url":"/api/auth_source_ldaps","http_method":"GET","short_description":"List all LDAP authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_source_ldaps","http_method":"GET","short_description":"List LDAP authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/show","name":"show","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"GET","short_description":"Show an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/update","name":"update","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"PUT","short_description":"Update an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_ldap","full_name":"auth_source_ldap","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"auth_source_ldap[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"auth_source_ldap[host]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"port","full_name":"auth_source_ldap[port]","description":"\n\u003cp\u003edefaults to 389\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"auth_source_ldap[account]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"base_dn","full_name":"auth_source_ldap[base_dn]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_password","full_name":"auth_source_ldap[account_password]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_login","full_name":"auth_source_ldap[attr_login]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_firstname","full_name":"auth_source_ldap[attr_firstname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_lastname","full_name":"auth_source_ldap[attr_lastname]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_mail","full_name":"auth_source_ldap[attr_mail]","description":"\n\u003cp\u003erequired if onthefly_register is true\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attr_photo","full_name":"auth_source_ldap[attr_photo]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"onthefly_register","full_name":"auth_source_ldap[onthefly_register]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"usergroup_sync","full_name":"auth_source_ldap[usergroup_sync]","description":"\n\u003cp\u003esync external user groups on login\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tls","full_name":"auth_source_ldap[tls]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"groups_base","full_name":"auth_source_ldap[groups_base]","description":"\n\u003cp\u003egroups base DN\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_netgroups","full_name":"auth_source_ldap[use_netgroups]","description":"\n\u003cp\u003euse NIS netgroups instead of posix groups, applicable only when server_type\nis posix or free_ipa\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"server_type","full_name":"auth_source_ldap[server_type]","description":"\n\u003cp\u003etype of the LDAP server\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003efree_ipa\u003c/code\u003e, \u003ccode\u003eactive_directory\u003c/code\u003e, \u003ccode\u003eposix\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ldap_filter","full_name":"auth_source_ldap[ldap_filter]","description":"\n\u003cp\u003eLDAP filter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"auth_source_ldap[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"auth_source_ldap[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/test","name":"test","apis":[{"api_url":"/api/auth_source_ldaps/:id/test","http_method":"PUT","short_description":"Test LDAP connection","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/auth_source_ldaps/destroy","name":"destroy","apis":[{"api_url":"/api/auth_source_ldaps/:id","http_method":"DELETE","short_description":"Delete an LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"template_kinds":{"doc_url":"../apidoc/v2/template_kinds","id":"template_kinds","api_url":"/api","name":"Template kinds","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/template_kinds/index","name":"index","apis":[{"api_url":"/api/template_kinds","http_method":"GET","short_description":"List all template kinds","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"auth_sources":{"doc_url":"../apidoc/v2/auth_sources","id":"auth_sources","api_url":"/api","name":"Auth sources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/auth_sources/index","name":"index","apis":[{"api_url":"/api/auth_sources","http_method":"GET","short_description":"List all authentication sources","deprecated":null},{"api_url":"/api/locations/:location_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/auth_sources","http_method":"GET","short_description":"List all authentication sources per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"trends":{"doc_url":"../apidoc/v2/trends","id":"trends","api_url":"/api","name":"Trends","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API enpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/trends/index","name":"index","apis":[{"api_url":"/api/trends","http_method":"GET","short_description":"List of trends counters","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/show","name":"show","apis":[{"api_url":"/api/trends/:id","http_method":"GET","short_description":"Show a trend","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/create","name":"create","apis":[{"api_url":"/api/trends","http_method":"POST","short_description":"Create a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/trends/destroy","name":"destroy","apis":[{"api_url":"/api/trends/:id","http_method":"DELETE","short_description":"Delete a trend counter","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nStatistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"autosign":{"doc_url":"../apidoc/v2/autosign","id":"autosign","api_url":"/api","name":"Autosign","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/autosign/index","name":"index","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"GET","short_description":"List all autosign entries","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/create","name":"create","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign","http_method":"POST","short_description":"Create autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/autosign/destroy","name":"destroy","apis":[{"api_url":"/api/smart_proxies/:smart_proxy_id/autosign/:id","http_method":"DELETE","short_description":"Delete autosign entry","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eAutosign entry name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"usergroups":{"doc_url":"../apidoc/v2/usergroups","id":"usergroups","api_url":"/api","name":"Usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups","http_method":"GET","short_description":"List all user groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:id","http_method":"GET","short_description":"Show a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups","http_method":"POST","short_description":"Create a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:id","http_method":"PUT","short_description":"Update a user group","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUser groups linked to external groups (LDAP) are automatically synced with\nthese groups on update. Remember this synchronization will remove any LDAP\nusers manually added to the Foreman user group. Only LDAP users in the\nexternal groups will remain. Internal users can be added or removed freely.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup","full_name":"usergroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"usergroup[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"admin","full_name":"usergroup[admin]","description":"\n\u003cp\u003eis an admin user group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"usergroup[user_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"usergroup_ids","full_name":"usergroup[usergroup_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"usergroup[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:id","http_method":"DELETE","short_description":"Delete a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"bookmarks":{"doc_url":"../apidoc/v2/bookmarks","id":"bookmarks","api_url":"/api","name":"Bookmarks","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/bookmarks/index","name":"index","apis":[{"api_url":"/api/bookmarks","http_method":"GET","short_description":"List all bookmarks","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"controller","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/show","name":"show","apis":[{"api_url":"/api/bookmarks/:id","http_method":"GET","short_description":"Show a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/update","name":"update","apis":[{"api_url":"/api/bookmarks/:id","http_method":"PUT","short_description":"Update a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"bookmark","full_name":"bookmark","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"bookmark[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"controller","full_name":"bookmark[controller]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"query","full_name":"bookmark[query]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public","full_name":"bookmark[public]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/bookmarks/destroy","name":"destroy","apis":[{"api_url":"/api/bookmarks/:id","http_method":"DELETE","short_description":"Delete a bookmark","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"provisioning_templates":{"doc_url":"../apidoc/v2/provisioning_templates","id":"provisioning_templates","api_url":"/api","name":"Provisioning templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/provisioning_templates/index","name":"index","apis":[{"api_url":"/api/provisioning_templates","http_method":"GET","short_description":"List provisioning templates","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per operating system","deprecated":null},{"api_url":"/api/locations/:location_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/provisioning_templates","http_method":"GET","short_description":"List provisioning templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default_template","values":["true","false"]},{"name":"environment","type":"string"},{"name":"hostgroup","type":"string"},{"name":"kind","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"operatingsystem","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/show","name":"show","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"GET","short_description":"Show provisioning template details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/import","name":"import","apis":[{"api_url":"/api/provisioning_templates/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/update","name":"update","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"PUT","short_description":"Update a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"provisioning_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"provisioning_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"provisioning_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"provisioning_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template_kind_id","full_name":"provisioning_template[template_kind_id]","description":"\n\u003cp\u003enot relevant for snippet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_combinations_attributes","full_name":"provisioning_template[template_combinations_attributes]","description":"\n\u003cp\u003eArray of template combinations (hostgroup_id, environment_id)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"provisioning_template[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"provisioning_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"provisioning_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"provisioning_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/revision","name":"revision","apis":[{"api_url":"/api/provisioning_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/destroy","name":"destroy","apis":[{"api_url":"/api/provisioning_templates/:id","http_method":"DELETE","short_description":"Delete a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/clone","name":"clone","apis":[{"api_url":"/api/provisioning_templates/:id/clone","http_method":"POST","short_description":"Clone a provision template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template","full_name":"provisioning_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"provisioning_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/provisioning_templates/export","name":"export","apis":[{"api_url":"/api/provisioning_templates/:id/export","http_method":"GET","short_description":"Export a provisioning template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"common_parameters":{"doc_url":"../apidoc/v2/common_parameters","id":"common_parameters","api_url":"/api","name":"Common parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/common_parameters/index","name":"index","apis":[{"api_url":"/api/common_parameters","http_method":"GET","short_description":"List all global parameters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/show","name":"show","apis":[{"api_url":"/api/common_parameters/:id","http_method":"GET","short_description":"Show a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/update","name":"update","apis":[{"api_url":"/api/common_parameters/:id","http_method":"PUT","short_description":"Update a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"common_parameter","full_name":"common_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"common_parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"common_parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"common_parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"common_parameter[hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/common_parameters/destroy","name":"destroy","apis":[{"api_url":"/api/common_parameters/:id","http_method":"DELETE","short_description":"Delete a global parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ptables":{"doc_url":"../apidoc/v2/ptables","id":"ptables","api_url":"/api","name":"Ptables","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ptables/index","name":"index","apis":[{"api_url":"/api/ptables","http_method":"GET","short_description":"List all partition tables","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/ptables","http_method":"GET","short_description":"List all partition tables for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/ptables","http_method":"GET","short_description":"List all partition tables per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/ptables","http_method":"GET","short_description":"List all partition tables per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"family","type":"string"},{"name":"layout","type":"text"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"},{"name":"vendor","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/show","name":"show","apis":[{"api_url":"/api/ptables/:id","http_method":"GET","short_description":"Show a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/import","name":"import","apis":[{"api_url":"/api/ptables/import","http_method":"POST","short_description":"Import a provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"ptable[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/revision","name":"revision","apis":[{"api_url":"/api/ptables/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/update","name":"update","apis":[{"api_url":"/api/ptables/:id","http_method":"PUT","short_description":"Update a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"ptable[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"layout","full_name":"ptable[layout]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"ptable[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"ptable[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"ptable[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"ptable[os_family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"ptable[operatingsystem_ids]","description":"\n\u003cp\u003eArray of operating system IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"host_ids","full_name":"ptable[host_ids]","description":"\n\u003cp\u003eArray of host IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"ptable[hostgroup_ids]","description":"\n\u003cp\u003eArray of host group IDs to associate with the partition table\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"ptable[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"ptable[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/destroy","name":"destroy","apis":[{"api_url":"/api/ptables/:id","http_method":"DELETE","short_description":"Delete a partition table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/clone","name":"clone","apis":[{"api_url":"/api/ptables/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable","full_name":"ptable","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ptable[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ptables/export","name":"export","apis":[{"api_url":"/api/ptables/:id/export","http_method":"GET","short_description":"Export a partition template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_attributes":{"doc_url":"../apidoc/v2/compute_attributes","id":"compute_attributes","api_url":"/api","name":"Compute attributes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_attributes/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for provided compute profile and compute resource","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute resource","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"GET","short_description":"List of compute attributes for compute profile","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"List of compute attributes","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"\n\u003cp\u003eID of compute profile\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute_resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"compute_profile","type":"string"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"GET","short_description":"Show a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes","http_method":"POST","short_description":"Create a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_attributes/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_resources/:compute_resource_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_profiles/:compute_profile_id/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null},{"api_url":"/api/compute_attributes/:id","http_method":"PUT","short_description":"Update a compute attributes set","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"compute_profile_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attribute","full_name":"compute_attribute","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"vm_attrs","full_name":"compute_attribute[vm_attrs]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppetclasses":{"doc_url":"../apidoc/v2/puppetclasses","id":"puppetclasses","api_url":"/api","name":"Puppetclasses","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppetclasses/index","name":"index","apis":[{"api_url":"/api/puppetclasses","http_method":"GET","short_description":"List all Puppet classes","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses","http_method":"GET","short_description":"List all Puppet classes for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"hostgroup","type":"string"},{"name":"key","type":"string"},{"name":"location","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/show","name":"show","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class","deprecated":null},{"api_url":"/api/hosts/:host_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for a host group","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:id","http_method":"GET","short_description":"Show a Puppet class for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/create","name":"create","apis":[{"api_url":"/api/puppetclasses","http_method":"POST","short_description":"Create a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/update","name":"update","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"PUT","short_description":"Update a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass","full_name":"puppetclass","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"puppetclass[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/puppetclasses/destroy","name":"destroy","apis":[{"api_url":"/api/puppetclasses/:id","http_method":"DELETE","short_description":"Delete a Puppet class","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"compute_profiles":{"doc_url":"../apidoc/v2/compute_profiles","id":"compute_profiles","api_url":"/api","name":"Compute profiles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_profiles/index","name":"index","apis":[{"api_url":"/api/compute_profiles","http_method":"GET","short_description":"List of compute profiles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/show","name":"show","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"GET","short_description":"Show a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/update","name":"update","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"PUT","short_description":"Update a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile","full_name":"compute_profile","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_profile[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_profiles/destroy","name":"destroy","apis":[{"api_url":"/api/compute_profiles/:id","http_method":"DELETE","short_description":"Delete a compute profile","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"puppet_hosts":{"doc_url":"../apidoc/v2/puppet_hosts","id":"puppet_hosts","api_url":"/api","name":"Puppet hosts","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Remote Execution Plugin.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/puppet_hosts/puppetrun","name":"puppetrun","apis":[{"api_url":"/api/hosts/:id/puppetrun","http_method":"PUT","short_description":"Force a Puppet agent run on the host","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install Foreman\nRemote Execution Plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"compute_resources":{"doc_url":"../apidoc/v2/compute_resources","id":"compute_resources","api_url":"/api","name":"Compute resources","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/compute_resources/index","name":"index","apis":[{"api_url":"/api/compute_resources","http_method":"GET","short_description":"List all compute resources","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/update","name":"update","apis":[{"api_url":"/api/compute_resources/:id","http_method":"PUT","short_description":"Update a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource","full_name":"compute_resource","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"compute_resource[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"compute_resource[provider]","description":"\n\u003cp\u003eProviders include\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"compute_resource[url]","description":"\n\u003cp\u003eURL for Libvirt, oVirt and OpenStack\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"compute_resource[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"compute_resource[user]","description":"\n\u003cp\u003eUsername for oVirt, EC2, VMware, OpenStack. Access Key for EC2.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"compute_resource[password]","description":"\n\u003cp\u003ePassword for oVirt, EC2, VMware, OpenStack. Secret key for EC2\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"datacenter","full_name":"compute_resource[datacenter]","description":"\n\u003cp\u003efor oVirt, VMware Datacenter\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"use_v4","full_name":"compute_resource[use_v4]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"ovirt_quota","full_name":"compute_resource[ovirt_quota]","description":"\n\u003cp\u003efor oVirt only, ID or Name of quota to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"public_key","full_name":"compute_resource[public_key]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"region","full_name":"compute_resource[region]","description":"\n\u003cp\u003efor AzureRm eg. \u0026#39;eastus\u0026#39; and for EC2 only. Use\n\u0026#39;us-gov-west-1\u0026#39; for EC2 GovCloud region\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tenant","full_name":"compute_resource[tenant]","description":"\n\u003cp\u003efor OpenStack and AzureRm only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"compute_resource[domain]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_name","full_name":"compute_resource[project_domain_name]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"project_domain_id","full_name":"compute_resource[project_domain_id]","description":"\n\u003cp\u003efor OpenStack (v3) only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"server","full_name":"compute_resource[server]","description":"\n\u003cp\u003efor VMware\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"set_console_password","full_name":"compute_resource[set_console_password]","description":"\n\u003cp\u003efor Libvirt and VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"display_type","full_name":"compute_resource[display_type]","description":"\n\u003cp\u003efor Libvirt and oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eVNC\u003c/code\u003e, \u003ccode\u003eSPICE\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"keyboard_layout","full_name":"compute_resource[keyboard_layout]","description":"\n\u003cp\u003efor oVirt only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ear\u003c/code\u003e, \u003ccode\u003ede-ch\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efo\u003c/code\u003e, \u003ccode\u003efr-ca\u003c/code\u003e, \u003ccode\u003ehu\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003emk\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e, \u003ccode\u003ept-br\u003c/code\u003e, \u003ccode\u003esv\u003c/code\u003e, \u003ccode\u003eda\u003c/code\u003e, \u003ccode\u003een-gb\u003c/code\u003e, \u003ccode\u003eet\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003efr-ch\u003c/code\u003e, \u003ccode\u003eis\u003c/code\u003e, \u003ccode\u003elt\u003c/code\u003e, \u003ccode\u003enl\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003eth\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een-us\u003c/code\u003e, \u003ccode\u003efi\u003c/code\u003e, \u003ccode\u003efr-be\u003c/code\u003e, \u003ccode\u003ehr\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003elv\u003c/code\u003e, \u003ccode\u003enl-be\u003c/code\u003e, \u003ccode\u003ept\u003c/code\u003e, \u003ccode\u003esl\u003c/code\u003e, \u003ccode\u003etr\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"caching_enabled","full_name":"compute_resource[caching_enabled]","description":"\n\u003cp\u003eenable caching, for VMware only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"project","full_name":"compute_resource[project]","description":"\n\u003cp\u003eProject id for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"compute_resource[email]","description":"\n\u003cp\u003eEmail for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key_path","full_name":"compute_resource[key_path]","description":"\n\u003cp\u003eCertificate path for GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zone","full_name":"compute_resource[zone]","description":"\n\u003cp\u003efor GCE only\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"compute_resource[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"compute_resource[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:id","http_method":"DELETE","short_description":"Delete a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_resource_pools","name":"available_resource_pools","apis":[{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_resource_pools","http_method":"GET","short_description":"List resource pools for a compute resource cluster","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_domain","name":"storage_domain","apis":[{"api_url":"/api/compute_resources/:id/storage_domains/:storage_domain_id","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain_id","full_name":"storage_domain_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_domains","name":"available_storage_domains","apis":[{"api_url":"/api/compute_resources/:id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_domains/:storage_domain","http_method":"GET","short_description":"List attributes for a given storage domain","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_domains","http_method":"GET","short_description":"List storage domains for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_domain","full_name":"storage_domain","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/storage_pod","name":"storage_pod","apis":[{"api_url":"/api/compute_resources/:id/storage_pods/:storage_pod_id","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod_id","full_name":"storage_pod_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_storage_pods","name":"available_storage_pods","apis":[{"api_url":"/api/compute_resources/:id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null},{"api_url":"/api/compute_resources/:id/available_storage_pods/:storage_pod","http_method":"GET","short_description":"List attributes for a given storage pod","deprecated":null},{"api_url":"/api/compute_resources/:id/available_clusters/:cluster_id/available_storage_pods","http_method":"GET","short_description":"List storage pods for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cluster_id","full_name":"cluster_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"storage_pod","full_name":"storage_pod","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/available_security_groups","name":"available_security_groups","apis":[{"api_url":"/api/compute_resources/:id/available_security_groups","http_method":"GET","short_description":"List available security groups for a compute resource","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/compute_resources/associate","name":"associate","apis":[{"api_url":"/api/compute_resources/:id/associate","http_method":"PUT","short_description":"Associate VMs to Hosts","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vm_id","full_name":"vm_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"users":{"doc_url":"../apidoc/v2/users","id":"users","api_url":"/api","name":"Users","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/users/index","name":"index","apis":[{"api_url":"/api/users","http_method":"GET","short_description":"List all users","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/users","http_method":"GET","short_description":"List all users for LDAP authentication source","deprecated":null},{"api_url":"/api/auth_source_externals/:auth_source_external_id/users","http_method":"GET","short_description":"List all users for external authentication source","deprecated":null},{"api_url":"/api/usergroups/:usergroup_id/users","http_method":"GET","short_description":"List all users for user group","deprecated":null},{"api_url":"/api/roles/:role_id/users","http_method":"GET","short_description":"List all users for role","deprecated":null},{"api_url":"/api/locations/:location_id/users","http_method":"GET","short_description":"List all users for location","deprecated":null},{"api_url":"/api/organizations/:organization_id/users","http_method":"GET","short_description":"List all users for organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"auth_source_ldap_id","full_name":"auth_source_ldap_id","description":"\n\u003cp\u003eID of LDAP authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID of user group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_id","full_name":"role_id","description":"\n\u003cp\u003eID of role\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/show_current","name":"show_current","apis":[{"api_url":"/api/current_user","http_method":"GET","short_description":"Show the currently logged-in user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/create","name":"create","apis":[{"api_url":"/api/users","http_method":"POST","short_description":"Create a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user by default\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/update","name":"update","apis":[{"api_url":"/api/users/:id","http_method":"PUT","short_description":"Update a user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAdds role \u0026#39;Default role\u0026#39; to the user if it is not already present.\nOnly another admin can change the admin account attribute.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user","full_name":"user","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"login","full_name":"user[login]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"firstname","full_name":"user[firstname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lastname","full_name":"user[lastname]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail","full_name":"user[mail]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"user[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":[]},{"name":"admin","full_name":"user[admin]","description":"\n\u003cp\u003eis an admin account\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"user[password]","description":"\n\u003cp\u003eRequired unless user is in an external authentication source\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_location_id","full_name":"user[default_location_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"default_organization_id","full_name":"user[default_organization_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"user[auth_source_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"timezone","full_name":"user[timezone]","description":"\n\u003cp\u003eUser\u0026#39;s timezone\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eInternational Date Line West\u003c/code\u003e, \u003ccode\u003eAmerican Samoa\u003c/code\u003e, \u003ccode\u003eMidway Island\u003c/code\u003e, \u003ccode\u003eHawaii\u003c/code\u003e, \u003ccode\u003eAlaska\u003c/code\u003e, \u003ccode\u003ePacific Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eTijuana\u003c/code\u003e, \u003ccode\u003eArizona\u003c/code\u003e, \u003ccode\u003eChihuahua\u003c/code\u003e, \u003ccode\u003eMazatlan\u003c/code\u003e, \u003ccode\u003eMountain Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eCentral America\u003c/code\u003e, \u003ccode\u003eCentral Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eGuadalajara\u003c/code\u003e, \u003ccode\u003eMexico City\u003c/code\u003e, \u003ccode\u003eMonterrey\u003c/code\u003e, \u003ccode\u003eSaskatchewan\u003c/code\u003e, \u003ccode\u003eBogota\u003c/code\u003e, \u003ccode\u003eEastern Time (US \u0026amp; Canada)\u003c/code\u003e, \u003ccode\u003eIndiana (East)\u003c/code\u003e, \u003ccode\u003eLima\u003c/code\u003e, \u003ccode\u003eQuito\u003c/code\u003e, \u003ccode\u003eAtlantic Time (Canada)\u003c/code\u003e, \u003ccode\u003eCaracas\u003c/code\u003e, \u003ccode\u003eGeorgetown\u003c/code\u003e, \u003ccode\u003eLa Paz\u003c/code\u003e, \u003ccode\u003ePuerto Rico\u003c/code\u003e, \u003ccode\u003eSantiago\u003c/code\u003e, \u003ccode\u003eNewfoundland\u003c/code\u003e, \u003ccode\u003eBrasilia\u003c/code\u003e, \u003ccode\u003eBuenos Aires\u003c/code\u003e, \u003ccode\u003eGreenland\u003c/code\u003e, \u003ccode\u003eMontevideo\u003c/code\u003e, \u003ccode\u003eMid-Atlantic\u003c/code\u003e, \u003ccode\u003eAzores\u003c/code\u003e, \u003ccode\u003eCape Verde Is.\u003c/code\u003e, \u003ccode\u003eCasablanca\u003c/code\u003e, \u003ccode\u003eDublin\u003c/code\u003e, \u003ccode\u003eEdinburgh\u003c/code\u003e, \u003ccode\u003eLisbon\u003c/code\u003e, \u003ccode\u003eLondon\u003c/code\u003e, \u003ccode\u003eMonrovia\u003c/code\u003e, \u003ccode\u003eUTC\u003c/code\u003e, \u003ccode\u003eAmsterdam\u003c/code\u003e, \u003ccode\u003eBelgrade\u003c/code\u003e, \u003ccode\u003eBerlin\u003c/code\u003e, \u003ccode\u003eBern\u003c/code\u003e, \u003ccode\u003eBratislava\u003c/code\u003e, \u003ccode\u003eBrussels\u003c/code\u003e, \u003ccode\u003eBudapest\u003c/code\u003e, \u003ccode\u003eCopenhagen\u003c/code\u003e, \u003ccode\u003eLjubljana\u003c/code\u003e, \u003ccode\u003eMadrid\u003c/code\u003e, \u003ccode\u003eParis\u003c/code\u003e, \u003ccode\u003ePrague\u003c/code\u003e, \u003ccode\u003eRome\u003c/code\u003e, \u003ccode\u003eSarajevo\u003c/code\u003e, \u003ccode\u003eSkopje\u003c/code\u003e, \u003ccode\u003eStockholm\u003c/code\u003e, \u003ccode\u003eVienna\u003c/code\u003e, \u003ccode\u003eWarsaw\u003c/code\u003e, \u003ccode\u003eWest Central Africa\u003c/code\u003e, \u003ccode\u003eZagreb\u003c/code\u003e, \u003ccode\u003eZurich\u003c/code\u003e, \u003ccode\u003eAthens\u003c/code\u003e, \u003ccode\u003eBucharest\u003c/code\u003e, \u003ccode\u003eCairo\u003c/code\u003e, \u003ccode\u003eHarare\u003c/code\u003e, \u003ccode\u003eHelsinki\u003c/code\u003e, \u003ccode\u003eJerusalem\u003c/code\u003e, \u003ccode\u003eKaliningrad\u003c/code\u003e, \u003ccode\u003eKyiv\u003c/code\u003e, \u003ccode\u003ePretoria\u003c/code\u003e, \u003ccode\u003eRiga\u003c/code\u003e, \u003ccode\u003eSofia\u003c/code\u003e, \u003ccode\u003eTallinn\u003c/code\u003e, \u003ccode\u003eVilnius\u003c/code\u003e, \u003ccode\u003eBaghdad\u003c/code\u003e, \u003ccode\u003eIstanbul\u003c/code\u003e, \u003ccode\u003eKuwait\u003c/code\u003e, \u003ccode\u003eMinsk\u003c/code\u003e, \u003ccode\u003eMoscow\u003c/code\u003e, \u003ccode\u003eNairobi\u003c/code\u003e, \u003ccode\u003eRiyadh\u003c/code\u003e, \u003ccode\u003eSt. Petersburg\u003c/code\u003e, \u003ccode\u003eTehran\u003c/code\u003e, \u003ccode\u003eAbu Dhabi\u003c/code\u003e, \u003ccode\u003eBaku\u003c/code\u003e, \u003ccode\u003eMuscat\u003c/code\u003e, \u003ccode\u003eSamara\u003c/code\u003e, \u003ccode\u003eTbilisi\u003c/code\u003e, \u003ccode\u003eVolgograd\u003c/code\u003e, \u003ccode\u003eYerevan\u003c/code\u003e, \u003ccode\u003eKabul\u003c/code\u003e, \u003ccode\u003eEkaterinburg\u003c/code\u003e, \u003ccode\u003eIslamabad\u003c/code\u003e, \u003ccode\u003eKarachi\u003c/code\u003e, \u003ccode\u003eTashkent\u003c/code\u003e, \u003ccode\u003eChennai\u003c/code\u003e, \u003ccode\u003eKolkata\u003c/code\u003e, \u003ccode\u003eMumbai\u003c/code\u003e, \u003ccode\u003eNew Delhi\u003c/code\u003e, \u003ccode\u003eSri Jayawardenepura\u003c/code\u003e, \u003ccode\u003eKathmandu\u003c/code\u003e, \u003ccode\u003eAlmaty\u003c/code\u003e, \u003ccode\u003eAstana\u003c/code\u003e, \u003ccode\u003eDhaka\u003c/code\u003e, \u003ccode\u003eUrumqi\u003c/code\u003e, \u003ccode\u003eRangoon\u003c/code\u003e, \u003ccode\u003eBangkok\u003c/code\u003e, \u003ccode\u003eHanoi\u003c/code\u003e, \u003ccode\u003eJakarta\u003c/code\u003e, \u003ccode\u003eKrasnoyarsk\u003c/code\u003e, \u003ccode\u003eNovosibirsk\u003c/code\u003e, \u003ccode\u003eBeijing\u003c/code\u003e, \u003ccode\u003eChongqing\u003c/code\u003e, \u003ccode\u003eHong Kong\u003c/code\u003e, \u003ccode\u003eIrkutsk\u003c/code\u003e, \u003ccode\u003eKuala Lumpur\u003c/code\u003e, \u003ccode\u003ePerth\u003c/code\u003e, \u003ccode\u003eSingapore\u003c/code\u003e, \u003ccode\u003eTaipei\u003c/code\u003e, \u003ccode\u003eUlaanbaatar\u003c/code\u003e, \u003ccode\u003eOsaka\u003c/code\u003e, \u003ccode\u003eSapporo\u003c/code\u003e, \u003ccode\u003eSeoul\u003c/code\u003e, \u003ccode\u003eTokyo\u003c/code\u003e, \u003ccode\u003eYakutsk\u003c/code\u003e, \u003ccode\u003eAdelaide\u003c/code\u003e, \u003ccode\u003eDarwin\u003c/code\u003e, \u003ccode\u003eBrisbane\u003c/code\u003e, \u003ccode\u003eCanberra\u003c/code\u003e, \u003ccode\u003eGuam\u003c/code\u003e, \u003ccode\u003eHobart\u003c/code\u003e, \u003ccode\u003eMelbourne\u003c/code\u003e, \u003ccode\u003ePort Moresby\u003c/code\u003e, \u003ccode\u003eSydney\u003c/code\u003e, \u003ccode\u003eVladivostok\u003c/code\u003e, \u003ccode\u003eMagadan\u003c/code\u003e, \u003ccode\u003eNew Caledonia\u003c/code\u003e, \u003ccode\u003eSolomon Is.\u003c/code\u003e, \u003ccode\u003eSrednekolymsk\u003c/code\u003e, \u003ccode\u003eAuckland\u003c/code\u003e, \u003ccode\u003eFiji\u003c/code\u003e, \u003ccode\u003eKamchatka\u003c/code\u003e, \u003ccode\u003eMarshall Is.\u003c/code\u003e, \u003ccode\u003eWellington\u003c/code\u003e, \u003ccode\u003eChatham Is.\u003c/code\u003e, \u003ccode\u003eNuku\u0026#39;alofa\u003c/code\u003e, \u003ccode\u003eSamoa\u003c/code\u003e, \u003ccode\u003eTokelau Is.\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locale","full_name":"user[locale]","description":"\n\u003cp\u003eUser\u0026#39;s preferred locale\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eca\u003c/code\u003e, \u003ccode\u003ecs_CZ\u003c/code\u003e, \u003ccode\u003ede\u003c/code\u003e, \u003ccode\u003een\u003c/code\u003e, \u003ccode\u003een_GB\u003c/code\u003e, \u003ccode\u003ees\u003c/code\u003e, \u003ccode\u003efr\u003c/code\u003e, \u003ccode\u003egl\u003c/code\u003e, \u003ccode\u003eit\u003c/code\u003e, \u003ccode\u003eja\u003c/code\u003e, \u003ccode\u003eko\u003c/code\u003e, \u003ccode\u003enl_NL\u003c/code\u003e, \u003ccode\u003epl\u003c/code\u003e, \u003ccode\u003ept_BR\u003c/code\u003e, \u003ccode\u003eru\u003c/code\u003e, \u003ccode\u003esv_SE\u003c/code\u003e, \u003ccode\u003ezh_CN\u003c/code\u003e, \u003ccode\u003ezh_TW\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role_ids","full_name":"user[role_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"user[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"user[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"current_password","full_name":"user[current_password]","description":"\n\u003cp\u003eRequired when user want to change own password\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/users/destroy","name":"destroy","apis":[{"api_url":"/api/users/:id","http_method":"DELETE","short_description":"Delete a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_groups":{"doc_url":"../apidoc/v2/config_groups","id":"config_groups","api_url":"/api","name":"Config groups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_groups/index","name":"index","apis":[{"api_url":"/api/config_groups","http_method":"GET","short_description":"List of config groups","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"class","type":"string"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/show","name":"show","apis":[{"api_url":"/api/config_groups/:id","http_method":"GET","short_description":"Show a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/create","name":"create","apis":[{"api_url":"/api/config_groups","http_method":"POST","short_description":"Create a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/update","name":"update","apis":[{"api_url":"/api/config_groups/:id","http_method":"PUT","short_description":"Update a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"config_group","full_name":"config_group","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"config_group[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"config_group[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_groups/destroy","name":"destroy","apis":[{"api_url":"/api/config_groups/:id","http_method":"DELETE","short_description":"Delete a config group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"realms":{"doc_url":"../apidoc/v2/realms","id":"realms","api_url":"/api","name":"Realms","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/realms/index","name":"index","apis":[{"api_url":"/api/realms","http_method":"GET","short_description":"List of realms","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/show","name":"show","apis":[{"api_url":"/api/realms/:id","http_method":"GET","short_description":"Show a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or realm name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":true,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/update","name":"update","apis":[{"api_url":"/api/realms/:id","http_method":"PUT","short_description":"Update a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm","full_name":"realm","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"realm[name]","description":"\n\u003cp\u003eThe realm name, e.g. EXAMPLE.COM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"realm_proxy_id","full_name":"realm[realm_proxy_id]","description":"\n\u003cp\u003eProxy ID to use within this realm\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_type","full_name":"realm[realm_type]","description":"\n\u003cp\u003eRealm type, e.g. FreeIPA or Active Directory\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"realm[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"realm[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/realms/destroy","name":"destroy","apis":[{"api_url":"/api/realms/:id","http_method":"DELETE","short_description":"Delete a realm","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"config_reports":{"doc_url":"../apidoc/v2/config_reports","id":"config_reports","api_url":"/api","name":"Config reports","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/config_reports/index","name":"index","apis":[{"api_url":"/api/config_reports","http_method":"GET","short_description":"List all reports","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"applied","type":"integer"},{"name":"environment","type":"string"},{"name":"eventful","values":["true","false"]},{"name":"failed","type":"integer"},{"name":"failed_restarts","type":"integer"},{"name":"host","type":"string"},{"name":"host_id","type":"integer"},{"name":"hostgroup","type":"string"},{"name":"hostgroup_fullname","type":"string"},{"name":"hostgroup_title","type":"string"},{"name":"last_report","type":"datetime"},{"name":"location","type":"string"},{"name":"log","type":"text"},{"name":"organization","type":"string"},{"name":"origin","type":"string"},{"name":"pending","type":"integer"},{"name":"reported","type":"datetime"},{"name":"resource","type":"text"},{"name":"restarted","type":"integer"},{"name":"skipped","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/show","name":"show","apis":[{"api_url":"/api/config_reports/:id","http_method":"GET","short_description":"Show a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"config_report","full_name":"config_report","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"host","full_name":"config_report[host]","description":"\n\u003cp\u003eHostname or certname\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reported_at","full_name":"config_report[reported_at]","description":"\n\u003cp\u003eUTC time of report\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"config_report[status]","description":"\n\u003cp\u003eHash of status type totals\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"metrics","full_name":"config_report[metrics]","description":"\n\u003cp\u003eHash of report metrics, can be just {}\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"logs","full_name":"config_report[logs]","description":"\n\u003cp\u003eOptional array of log hashes\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/destroy","name":"destroy","apis":[{"api_url":"/api/config_reports/:id","http_method":"DELETE","short_description":"Delete a report","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/config_reports/last","name":"last","apis":[{"api_url":"/api/hosts/:host_id/config_reports/last","http_method":"GET","short_description":"Show the last report for a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"dashboard":{"doc_url":"../apidoc/v2/dashboard","id":"dashboard","api_url":"/api","name":"Dashboard","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/dashboard/index","name":"index","apis":[{"api_url":"/api/dashboard","http_method":"GET","short_description":"Get dashboard details","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"domains":{"doc_url":"../apidoc/v2/domains","id":"domains","api_url":"/api","name":"Domains","short_description":null,"full_description":"\n\u003cp\u003eForeman considers a domain and a DNS zone as the same thing. That is, if\nyou are planning to manage a site where all the machines are of the form\n\u003cem\u003ehostname\u003c/em\u003e.\u003cstrong\u003esomewhere.com\u003c/strong\u003e then the domain is\n\u003cstrong\u003esomewhere.com\u003c/strong\u003e. This allows Foreman to associate a puppet\nvariable with a domain/site and automatically append this variable to all\nexternal node requests made by machines at that site.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/domains/index","name":"index","apis":[{"api_url":"/api/domains","http_method":"GET","short_description":"List of domains","deprecated":null},{"api_url":"/api/subnets/:subnet_id/domains","http_method":"GET","short_description":"List of domains per subnet","deprecated":null},{"api_url":"/api/locations/:location_id/domains","http_method":"GET","short_description":"List of domains per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/domains","http_method":"GET","short_description":"List of domains per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"fullname","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/create","name":"create","apis":[{"api_url":"/api/domains","http_method":"POST","short_description":"Create a domain","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe \u003cstrong\u003efullname\u003c/strong\u003e field is used for human readability in\nreports and other pages that refer to domains, and also available as an\nexternal node parameter\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/update","name":"update","apis":[{"api_url":"/api/domains/:id","http_method":"PUT","short_description":"Update a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"domain[name]","description":"\n\u003cp\u003eThe full DNS domain name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fullname","full_name":"domain[fullname]","description":"\n\u003cp\u003eDescription of the domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"domain[dns_id]","description":"\n\u003cp\u003eDNS proxy ID to use within this domain\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_parameters_attributes","full_name":"domain[domain_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"domain[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"domain[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/domains/destroy","name":"destroy","apis":[{"api_url":"/api/domains/:id","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"environments":{"doc_url":"../apidoc/v2/environments","id":"environments","api_url":"/api","name":"Environments","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/environments/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/index","name":"index","apis":[{"api_url":"/api/environments","http_method":"GET","short_description":"List all environments","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/environments","http_method":"GET","short_description":"List environments of Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/environments","http_method":"GET","short_description":"List environments per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/environments","http_method":"GET","short_description":"List environments per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/show","name":"show","apis":[{"api_url":"/api/environments/:id","http_method":"GET","short_description":"Show an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/create","name":"create","apis":[{"api_url":"/api/environments","http_method":"POST","short_description":"Create an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/update","name":"update","apis":[{"api_url":"/api/environments/:id","http_method":"PUT","short_description":"Update an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment","full_name":"environment","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"environment[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"environment[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"environment[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/environments/destroy","name":"destroy","apis":[{"api_url":"/api/environments/:id","http_method":"DELETE","short_description":"Delete an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"registration":{"doc_url":"../apidoc/v2/registration","id":"registration","api_url":"/api","name":"Registration","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/registration/global","name":"global","apis":[{"api_url":"/api/register","http_method":"GET","short_description":"Render Global registration template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of the Organization to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of the Location to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of the Host group to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of the Operating System to register the host in.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"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\nset to true, insights client will be installed and registered on Red Hat\nfamily 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":[]},{"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\nit 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":[]}],"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 registration 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}]},{"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\nset to true, insights client will be installed and registered on Red Hat\nfamily 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":[]},{"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\nit 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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"interfaces":{"doc_url":"../apidoc/v2/interfaces","id":"interfaces","api_url":"/api","name":"Interfaces","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/interfaces/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"GET","short_description":"List all interfaces for host","deprecated":null},{"api_url":"/api/domains/:domain_id/interfaces","http_method":"GET","short_description":"List all interfaces for domain","deprecated":null},{"api_url":"/api/subnets/:subnet_id/interfaces","http_method":"GET","short_description":"List all interfaces for subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID or name of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID or name of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/interfaces","http_method":"POST","short_description":"Create an interface on a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"PUT","short_description":"Update a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"interface","full_name":"interface","description":"\n\u003cp\u003einterface information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"interface[mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"interface[ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"interface[ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"interface[type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"interface[name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"interface[subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"interface[subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"interface[domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"interface[identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"interface[managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"interface[primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"interface[provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"interface[username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"interface[password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"interface[provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"interface[virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"interface[tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"interface[mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"interface[attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"interface[mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"interface[attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"interface[bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"interface[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/interfaces/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/interfaces/:id","http_method":"DELETE","short_description":"Delete a host's interface","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID or name of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of interface\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"external_usergroups":{"doc_url":"../apidoc/v2/external_usergroups","id":"external_usergroups","api_url":"/api","name":"External usergroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/external_usergroups/index","name":"index","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups","http_method":"GET","short_description":"List all external user groups for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/show","name":"show","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for user group","deprecated":null},{"api_url":"/api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups/:id","http_method":"GET","short_description":"Show an external user group for LDAP authentication source","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/create","name":"create","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups","http_method":"POST","short_description":"Create an external user group linked to a user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/update","name":"update","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"PUT","short_description":"Update external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"external_usergroup","full_name":"external_usergroup","description":"\n\u003cp\u003eExternal user group information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"external_usergroup[name]","description":"\n\u003cp\u003eExternal user group name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auth_source_id","full_name":"external_usergroup[auth_source_id]","description":"\n\u003cp\u003eID of linked authentication source\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/refresh","name":"refresh","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id/refresh","http_method":"PUT","short_description":"Refresh external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name of external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/external_usergroups/destroy","name":"destroy","apis":[{"api_url":"/api/usergroups/:usergroup_id/external_usergroups/:id","http_method":"DELETE","short_description":"Delete an external user group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"usergroup_id","full_name":"usergroup_id","description":"\n\u003cp\u003eID or name of user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID or name external user group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"fact_values":{"doc_url":"../apidoc/v2/fact_values","id":"fact_values","api_url":"/api","name":"Fact values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/fact_values/index","name":"index","apis":[{"api_url":"/api/fact_values","http_method":"GET","short_description":"List all fact values","deprecated":null},{"api_url":"/api/hosts/:host_id/facts","http_method":"GET","short_description":"List all fact values of a given host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/filters/index","name":"index","apis":[{"api_url":"/api/filters","http_method":"GET","short_description":"List all filters","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"limited","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"override","values":["true","false"]},{"name":"permission","type":"string"},{"name":"resource","type":"string"},{"name":"role","type":"string"},{"name":"role_id","type":"integer"},{"name":"search","type":"text"},{"name":"unlimited","values":["true","false"]}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/show","name":"show","apis":[{"api_url":"/api/filters/:id","http_method":"GET","short_description":"Show a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/update","name":"update","apis":[{"api_url":"/api/filters/:id","http_method":"PUT","short_description":"Update a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"filter","full_name":"filter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"role_id","full_name":"filter[role_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"filter[search]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override","full_name":"filter[override]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"permission_ids","full_name":"filter[permission_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"filter[organization_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"filter[location_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/filters/destroy","name":"destroy","apis":[{"api_url":"/api/filters/:id","http_method":"DELETE","short_description":"Delete a filter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"home":{"doc_url":"../apidoc/v2/home","id":"home","api_url":"/api","name":"Home","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/home/index","name":"index","apis":[{"api_url":"/api","http_method":"GET","short_description":"Show available API links","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/home/status","name":"status","apis":[{"api_url":"/api/status","http_method":"GET","short_description":"Show status","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"host_classes":{"doc_url":"../apidoc/v2/host_classes","id":"host_classes","api_url":"/api","name":"Host classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/host_classes/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/host_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"report_templates":{"doc_url":"../apidoc/v2/report_templates","id":"report_templates","api_url":"/api","name":"Report templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/report_templates/index","name":"index","apis":[{"api_url":"/api/report_templates","http_method":"GET","short_description":"List all report templates","deprecated":null},{"api_url":"/api/locations/:location_id/report_templates","http_method":"GET","short_description":"List all report templates per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/report_templates","http_method":"GET","short_description":"List all report templates per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"default","values":["true","false"]},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"locked","values":["true","false"]},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"snippet","values":["true","false"]},{"name":"template","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/show","name":"show","apis":[{"api_url":"/api/report_templates/:id","http_method":"GET","short_description":"Show a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/import","name":"import","apis":[{"api_url":"/api/report_templates/import","http_method":"POST","short_description":"Import a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"\n\u003cp\u003etemplate contents including metadata\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"options","full_name":"options","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"force","full_name":"options[force]","description":"\n\u003cp\u003euse if you want update locked templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"associate","full_name":"options[associate]","description":"\n\u003cp\u003edetermines when the template should associate objects based on metadata,\nnew means only when new template is being created, always means both for\nnew and existing template which is only being updated, never ignores\nmetadata\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003ealways\u003c/code\u003e, \u003ccode\u003enever\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"lock","full_name":"options[lock]","description":"\n\u003cp\u003elock imported templates (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"options[default]","description":"\n\u003cp\u003emakes the template default meaning it will be automatically associated with\nnewly created organizations and locations (false by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/revision","name":"revision","apis":[{"api_url":"/api/report_templates/revision","http_method":"GET","short_description":null,"deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"version","full_name":"version","description":"\n\u003cp\u003etemplate version\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/update","name":"update","apis":[{"api_url":"/api/report_templates/:id","http_method":"PUT","short_description":"Update a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"report_template[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"template","full_name":"report_template[template]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"snippet","full_name":"report_template[snippet]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"audit_comment","full_name":"report_template[audit_comment]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"locked","full_name":"report_template[locked]","description":"\n\u003cp\u003eWhether or not the template is locked for editing\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"default","full_name":"report_template[default]","description":"\n\u003cp\u003eWhether or not the template is added automatically to new organizations and\nlocations\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"report_template[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"report_template[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/destroy","name":"destroy","apis":[{"api_url":"/api/report_templates/:id","http_method":"DELETE","short_description":"Delete a report template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/clone","name":"clone","apis":[{"api_url":"/api/report_templates/:id/clone","http_method":"POST","short_description":"Clone a template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_template","full_name":"report_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"report_template[name]","description":"\n\u003cp\u003etemplate name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/export","name":"export","apis":[{"api_url":"/api/report_templates/:id/export","http_method":"GET","short_description":"Export a report template to ERB","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report uzing gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/schedule_report","name":"schedule_report","apis":[{"api_url":"/api/report_templates/:id/schedule_report","http_method":"POST","short_description":"Schedule generating of a report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eThe reports are generated asynchronously. If mail_to is not given, action\nreturns an url to get resulting report from (see\n\u003cstrong\u003ereport_data\u003c/strong\u003e).\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"input_values","full_name":"input_values","description":"\n\u003cp\u003eHash of input values where key is the name of input, value is the value for\nthis input\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"gzip","full_name":"gzip","description":"\n\u003cp\u003eCompress the report using gzip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"mail_to","full_name":"mail_to","description":"\n\u003cp\u003eIf set, scheduled report will be delivered via e-mail. Use \u0026#39;,\u0026#39; to\nseparate multiple email addresses.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"generate_at","full_name":"generate_at","description":"\n\u003cp\u003eUTC time to generate report at\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_format","full_name":"report_format","description":"\n\u003cp\u003eReport format, defaults to \u0026#39;csv\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ecsv\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ehtml\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[{"code":200,"description":"a successful response","is_array":false,"returns_object":[{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eAn ID of job, which generates report. To be used with report_data API\nendpoint for report data retrieval.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true},{"name":"data_url","full_name":"data_url","description":"\n\u003cp\u003eAn url to get resulting report from. This is not available when report is\ndelivered via e-mail.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true}],"additional_properties":false}],"examples":["POST /api/report_templates/:id/schedule_report/\n200\n{\n \"job_id\": UNIQUE-REPORT-GENERATING-JOB-UUID\n \"data_url\": \"/api/v2/report_templates/1/report_data/UNIQUE-REPORT-GENERATING-JOB-UUID\"\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/report_templates/report_data","name":"report_data","apis":[{"api_url":"/api/report_templates/:id/report_data/:job_id","http_method":"GET","short_description":"Downloads a generated report","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns the report data as a raw response. In case the report hasn\u0026#39;t\nbeen generated yet, it will return an empty response with http status 204 -\nNoContent.\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_id","full_name":"job_id","description":"\n\u003cp\u003eID assigned to generating job by the schedule command\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroup_classes":{"doc_url":"../apidoc/v2/hostgroup_classes","id":"hostgroup_classes","api_url":"/api","name":"Hostgroup classes","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroup_classes/index","name":"index","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"GET","short_description":"List all Puppet class IDs for host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/create","name":"create","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids","http_method":"POST","short_description":"Add a Puppet class to host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroup_classes/destroy","name":"destroy","apis":[{"api_url":"/api/hostgroups/:hostgroup_id/puppetclass_ids/:id","http_method":"DELETE","short_description":"Remove a Puppet class from host group","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hostgroups":{"doc_url":"../apidoc/v2/hostgroups","id":"hostgroups","api_url":"/api","name":"Hostgroups","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hostgroups/index","name":"index","apis":[{"api_url":"/api/hostgroups","http_method":"GET","short_description":"List all host groups","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/hostgroups","http_method":"GET","short_description":"List all host groups for a Puppet class","deprecated":null},{"api_url":"/api/locations/:location_id/hostgroups","http_method":"GET","short_description":"List all host groups per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hostgroups","http_method":"GET","short_description":"List all host groups per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"puppetclass_id","full_name":"puppetclass_id","description":"\n\u003cp\u003eID of Puppet class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of [\"parameters\"]","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"class","type":"string"},{"name":"config_group","type":"string"},{"name":"environment","type":"string"},{"name":"host","type":"string"},{"name":"id","type":"integer"},{"name":"label","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"medium","type":"string"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"os","type":"string"},{"name":"os_description","type":"string"},{"name":"os_id","type":"integer"},{"name":"os_major","type":"string"},{"name":"os_minor","type":"string"},{"name":"os_title","type":"string"},{"name":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup","full_name":"hostgroup","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[name]","description":"\n\u003cp\u003eName of the host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"hostgroup[description]","description":"\n\u003cp\u003eHost group description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"hostgroup[parent_id]","description":"\n\u003cp\u003eParent ID of the host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"hostgroup[environment_id]","description":"\n\u003cp\u003eEnvironment ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"hostgroup[compute_profile_id]","description":"\n\u003cp\u003eCompute profile ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"hostgroup[compute_resource_id]","description":"\n\u003cp\u003eCompute resource ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"hostgroup[operatingsystem_id]","description":"\n\u003cp\u003eOperating system ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"hostgroup[architecture_id]","description":"\n\u003cp\u003eArchitecture ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"hostgroup[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"hostgroup[medium_id]","description":"\n\u003cp\u003eMedia ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"hostgroup[ptable_id]","description":"\n\u003cp\u003ePartition table ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"hostgroup[subnet_id]","description":"\n\u003cp\u003eSubnet ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"hostgroup[subnet6_id]","description":"\n\u003cp\u003eSubnet IPv6 ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"hostgroup[domain_id]","description":"\n\u003cp\u003eDomain ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"hostgroup[realm_id]","description":"\n\u003cp\u003eRealm ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"hostgroup[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"hostgroup[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"group_parameters_attributes","full_name":"hostgroup[group_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"hostgroup[group_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"hostgroup[group_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"hostgroup[group_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"hostgroup[group_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"puppet_proxy_id","full_name":"hostgroup[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"hostgroup[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"hostgroup[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"hostgroup[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hostgroups/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hostgroups/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"children_hosts","full_name":"children_hosts","description":"\n\u003cp\u003eOperate on child hostgroup hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"hosts":{"doc_url":"../apidoc/v2/hosts","id":"hosts","api_url":"/api","name":"Hosts","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/hosts/index","name":"index","apis":[{"api_url":"/api/hosts","http_method":"GET","short_description":"List all hosts","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/hosts","http_method":"GET","short_description":"List all hosts for a host group","deprecated":null},{"api_url":"/api/locations/:location_id/hosts","http_method":"GET","short_description":"List hosts per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/hosts","http_method":"GET","short_description":"List hosts per organization","deprecated":null},{"api_url":"/api/environments/:environment_id/hosts","http_method":"GET","short_description":"List hosts per environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"thin","full_name":"thin","description":"\n\u003cp\u003eOnly list ID and name of hosts\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"\n\u003cp\u003eID of environment\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"include","full_name":"include","description":"\n\u003cp\u003eArray of extra information types to include\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eparameters\u003c/code\u003e, \u003ccode\u003eall_parameters\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"boot_time","type":"datetime"},{"name":"build","values":["true","false"]},{"name":"class","type":"string"},{"name":"comment","type":"text"},{"name":"compute_resource","type":"string"},{"name":"compute_resource_id","type":"integer"},{"name":"config_group","type":"string"},{"name":"created_at","type":"datetime"},{"name":"domain","type":"string"},{"name":"domain_id","type":"integer"},{"name":"environment","type":"string"},{"name":"facts","type":"string"},{"name":"global_status","values":["ok","warning","error"]},{"name":"has_ip","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":"image","type":"string"},{"name":"installed_at","type":"datetime"},{"name":"ip","type":"string"},{"name":"last_report","type":"datetime"},{"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":"realm","type":"string"},{"name":"realm_id","type":"integer"},{"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":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/create","name":"create","apis":[{"api_url":"/api/hosts","http_method":"POST","short_description":"Create a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/update","name":"update","apis":[{"api_url":"/api/hosts/:id","http_method":"PUT","short_description":"Update a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"host","full_name":"host","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"host[location_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"host[organization_id]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"host[environment_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[ip]","description":"\n\u003cp\u003enot required if using a subnet with DHCP proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"host[mac]","description":"\n\u003cp\u003erequired for managed host that is bare metal, not required if it\u0026#39;s a\nvirtual machine\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"host[architecture_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[domain_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"realm_id","full_name":"host[realm_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_proxy_id","full_name":"host[puppet_proxy_id]","description":"\n\u003cp\u003ePuppet proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppet_ca_proxy_id","full_name":"host[puppet_ca_proxy_id]","description":"\n\u003cp\u003ePuppet CA proxy ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_ids","full_name":"host[puppetclass_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"config_group_ids","full_name":"host[config_group_ids]","description":"\n\u003cp\u003eIDs of associated config groups\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"host[operatingsystem_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"host[medium_id]","description":"\n\u003cp\u003erequired if not imaged based provisioning and host is managed and value is\nnot inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pxe_loader","full_name":"host[pxe_loader]","description":"\n\u003cp\u003eDHCP filename option (Grub2/PXELinux by default)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eNone\u003c/code\u003e, \u003ccode\u003ePXELinux BIOS\u003c/code\u003e, \u003ccode\u003ePXELinux UEFI\u003c/code\u003e, \u003ccode\u003eGrub UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 BIOS\u003c/code\u003e, \u003ccode\u003eGrub2 ELF\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI SecureBoot\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTP\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS\u003c/code\u003e, \u003ccode\u003eGrub2 UEFI HTTPS SecureBoot\u003c/code\u003e, \u003ccode\u003eiPXE Embedded\u003c/code\u003e, \u003ccode\u003eiPXE UEFI HTTP\u003c/code\u003e, \u003ccode\u003eiPXE Chain BIOS\u003c/code\u003e, \u003ccode\u003eiPXE Chain UEFI\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"host[ptable_id]","description":"\n\u003cp\u003erequired if host is managed and custom partition has not been defined\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[subnet_id]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"host[compute_resource_id]","description":"\n\u003cp\u003enil means host is bare metal\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"root_pass","full_name":"host[root_pass]","description":"\n\u003cp\u003erequired if host is managed and value is not inherited from host group or\ndefault password in settings\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"host[model_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"host[hostgroup_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_id","full_name":"host[owner_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"owner_type","full_name":"host[owner_type]","description":"\n\u003cp\u003eHost\u0026#39;s owner type\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eUser\u003c/code\u003e, \u003ccode\u003eUsergroup\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image_id","full_name":"host[image_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_parameters_attributes","full_name":"host[host_parameters_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s parameters (array or indexed hash)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"host[host_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"host[host_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"host[host_parameters_attributes][parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"host[host_parameters_attributes][hidden_value]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]},{"name":"build","full_name":"host[build]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"enabled","full_name":"host[enabled]","description":"\n\u003cp\u003eInclude this host within Foreman reporting\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision_method","full_name":"host[provision_method]","description":"\n\u003cp\u003eThe method used to provision the host.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebuild\u003c/code\u003e, \u003ccode\u003eimage\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[managed]","description":"\n\u003cp\u003eTrue/False flag whether a host is managed or unmanaged. Note: this value\nalso determines whether several parameters are required or not\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"progress_report_id","full_name":"host[progress_report_id]","description":"\n\u003cp\u003eUUID to track orchestration tasks status, GET\n/api/orchestration/:UUID/tasks\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"comment","full_name":"host[comment]","description":"\n\u003cp\u003eAdditional information about this host\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"capabilities","full_name":"host[capabilities]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_profile_id","full_name":"host[compute_profile_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interfaces_attributes","full_name":"host[interfaces_attributes]","description":"\n\u003cp\u003eHost\u0026#39;s network interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"mac","full_name":"host[interfaces_attributes][mac]","description":"\n\u003cp\u003eMAC address of interface. Required for managed interfaces on bare metal.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip","full_name":"host[interfaces_attributes][ip]","description":"\n\u003cp\u003eIPv4 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip6","full_name":"host[interfaces_attributes][ip6]","description":"\n\u003cp\u003eIPv6 address of interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"host[interfaces_attributes][type]","description":"\n\u003cp\u003eInterface type, e.g. bmc. Default is interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003einterface\u003c/code\u003e, \u003ccode\u003ebmc\u003c/code\u003e, \u003ccode\u003ebond\u003c/code\u003e, \u003ccode\u003ebridge\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"host[interfaces_attributes][name]","description":"\n\u003cp\u003eInterface\u0026#39;s DNS name\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"host[interfaces_attributes][subnet_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv4 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet6_id","full_name":"host[interfaces_attributes][subnet6_id]","description":"\n\u003cp\u003eForeman subnet ID of IPv6 interface\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"host[interfaces_attributes][domain_id]","description":"\n\u003cp\u003eForeman domain ID of interface. Required for primary interfaces on managed\nhosts.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"identifier","full_name":"host[interfaces_attributes][identifier]","description":"\n\u003cp\u003eDevice identifier, e.g. eth0 or eth1.1\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"managed","full_name":"host[interfaces_attributes][managed]","description":"\n\u003cp\u003eShould this interface be managed via DHCP and DNS smart proxy and should it\nbe configured during provisioning?\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"primary","full_name":"host[interfaces_attributes][primary]","description":"\n\u003cp\u003eShould this interface be used for constructing the FQDN of the host? Each\nmanaged hosts needs to have one primary interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"provision","full_name":"host[interfaces_attributes][provision]","description":"\n\u003cp\u003eShould this interface be used for TFTP of PXELinux (or SSH for image-based\nhosts)? Each managed hosts needs to have one provision interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"host[interfaces_attributes][username]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"host[interfaces_attributes][password]","description":"\n\u003cp\u003eOnly for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provider","full_name":"host[interfaces_attributes][provider]","description":"\n\u003cp\u003eInterface provider, e.g. IPMI. Only for BMC interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPMI\u003c/code\u003e, \u003ccode\u003eSSH\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"virtual","full_name":"host[interfaces_attributes][virtual]","description":"\n\u003cp\u003eAlias or VLAN device\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"host[interfaces_attributes][tag]","description":"\n\u003cp\u003eVLAN tag, this attribute has precedence over the subnet VLAN ID. Only for\nvirtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"host[interfaces_attributes][mtu]","description":"\n\u003cp\u003eMTU, this attribute has precedence over the subnet MTU.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"attached_to","full_name":"host[interfaces_attributes][attached_to]","description":"\n\u003cp\u003eIdentifier of the interface to which this interface belongs, e.g. eth1.\nOnly for virtual interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mode","full_name":"host[interfaces_attributes][mode]","description":"\n\u003cp\u003eBond mode of the interface, e.g. balance-rr. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ebalance-rr\u003c/code\u003e, \u003ccode\u003eactive-backup\u003c/code\u003e, \u003ccode\u003ebalance-xor\u003c/code\u003e, \u003ccode\u003ebroadcast\u003c/code\u003e, \u003ccode\u003e802.3ad\u003c/code\u003e, \u003ccode\u003ebalance-tlb\u003c/code\u003e, \u003ccode\u003ebalance-alb\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"attached_devices","full_name":"host[interfaces_attributes][attached_devices]","description":"\n\u003cp\u003eIdentifiers of attached interfaces, e.g. `[\u0026#39;eth1\u0026#39;,\n\u0026#39;eth2\u0026#39;]`. For bond interfaces those are the slaves. Only for bond\nand bridges interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"bond_options","full_name":"host[interfaces_attributes][bond_options]","description":"\n\u003cp\u003eSpace separated options, e.g. miimon=100. Only for bond interfaces.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_attributes","full_name":"host[interfaces_attributes][compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes for the interface.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]},{"name":"compute_attributes","full_name":"host[compute_attributes]","description":"\n\u003cp\u003eAdditional compute resource specific attributes.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:id","http_method":"DELETE","short_description":"Delete a host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/get_status","name":"get_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"GET","short_description":"Get status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns string representing a host status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type, can be one of\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eglobal\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003econfiguration\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003ebuild\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eHostStatus::Global\u003c/code\u003e, \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/forget_status","name":"forget_status","apis":[{"api_url":"/api/hosts/:id/status/:type","http_method":"DELETE","short_description":"Clear sub-status of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eClears a host sub-status of a given type\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003estatus type\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003econfiguration\u003c/code\u003e, \u003ccode\u003ebuild\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/vm_compute_attributes","name":"vm_compute_attributes","apis":[{"api_url":"/api/hosts/:id/vm_compute_attributes","http_method":"GET","short_description":"Get vm attributes of host","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn the host\u0026#39;s compute attributes that can be used to create a clone\nof this VM\u003c/p\u003e\n","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/disassociate","name":"disassociate","apis":[{"api_url":"/api/hosts/:id/disassociate","http_method":"PUT","short_description":"Disassociate the host from a VM","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power","name":"power","apis":[{"api_url":"/api/hosts/:id/power","http_method":"PUT","short_description":"Run a power operation on host","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"power_action","full_name":"power_action","description":"\n\u003cp\u003epower action, valid actions are (on/start), (off/stop), (soft/reboot),\n(cycle/reset), (state/status)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/power_status","name":"power_status","apis":[{"api_url":"/api/hosts/:id/power","http_method":"GET","short_description":"Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/boot","name":"boot","apis":[{"api_url":"/api/hosts/:id/boot","http_method":"PUT","short_description":"Boot host from specified device","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"device","full_name":"device","description":"\n\u003cp\u003eboot device, valid devices are disk, cdrom, pxe, bios\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/facts","name":"facts","apis":[{"api_url":"/api/hosts/facts","http_method":"POST","short_description":"Upload facts for a host, creating the host if required","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ehostname of the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"facts","full_name":"facts","description":"\n\u003cp\u003ehash containing the facts for the host\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[]},{"name":"certname","full_name":"certname","description":"\n\u003cp\u003eoptional: certname of the host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type","full_name":"type","description":"\n\u003cp\u003eoptional: the STI type of host to create\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/rebuild_config","name":"rebuild_config","apis":[{"api_url":"/api/hosts/:id/rebuild_config","http_method":"PUT","short_description":"Rebuild orchestration config","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n\u003cp\u003eLimit rebuild steps, valid steps are DHCP, DNS, TFTP\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/hosts/template","name":"template","apis":[{"api_url":"/api/hosts/:id/template/:kind","http_method":"GET","short_description":"Preview rendered provisioning template content","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"kind","full_name":"kind","description":"\n\u003cp\u003eTemplate kinds, available values: PXELinux, PXEGrub, PXEGrub2, iPXE,\nprovision, finish, script, user_data, ZTP, POAP, cloud-init, registration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"http_proxies":{"doc_url":"../apidoc/v2/http_proxies","id":"http_proxies","api_url":"/api","name":"Http proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/http_proxies/index","name":"index","apis":[{"api_url":"/api/http_proxies","http_method":"GET","short_description":"List of HTTP Proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/show","name":"show","apis":[{"api_url":"/api/http_proxies/:id","http_method":"GET","short_description":"Show an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eIdentifier of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/update","name":"update","apis":[{"api_url":"/api/http_proxies/:id","http_method":"PUT","short_description":"Update an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"http_proxy","full_name":"http_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"http_proxy[name]","description":"\n\u003cp\u003eThe HTTP Proxy name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"http_proxy[url]","description":"\n\u003cp\u003eURL of the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"http_proxy[username]","description":"\n\u003cp\u003eUsername used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"http_proxy[password]","description":"\n\u003cp\u003ePassword used to authenticate with the HTTP Proxy\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"http_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"http_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/http_proxies/destroy","name":"destroy","apis":[{"api_url":"/api/http_proxies/:id","http_method":"DELETE","short_description":"Delete an HTTP Proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"images":{"doc_url":"../apidoc/v2/images","id":"images","api_url":"/api","name":"Images","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/images/index","name":"index","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"GET","short_description":"List all images for a compute resource","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images","http_method":"GET","short_description":"List all images for operating system","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images","http_method":"GET","short_description":"List all images for architecture","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"integer"},{"name":"compute_resource","type":"string"},{"name":"name","type":"string"},{"name":"operatingsystem","type":"integer"},{"name":"user_data","values":["true","false"]},{"name":"username","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/show","name":"show","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null},{"api_url":"/api/architectures/:architecture_id/images/:id","http_method":"GET","short_description":"Show an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/create","name":"create","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images","http_method":"POST","short_description":"Create an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/update","name":"update","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"PUT","short_description":"Update an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"image","full_name":"image","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"image[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"username","full_name":"image[username]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"uuid","full_name":"image[uuid]","description":"\n\u003cp\u003eTemplate ID in the compute resource\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"password","full_name":"image[password]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"image[compute_resource_id]","description":"\n\u003cp\u003eID of compute resource\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"image[architecture_id]","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"image[operatingsystem_id]","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_data","full_name":"image[user_data]","description":"\n\u003cp\u003eWhether or not the image supports user data\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/images/destroy","name":"destroy","apis":[{"api_url":"/api/compute_resources/:compute_resource_id/images/:id","http_method":"DELETE","short_description":"Delete an image","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_id","full_name":"compute_resource_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"locations":{"doc_url":"../apidoc/v2/locations","id":"locations","api_url":"/api","name":"Locations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/locations/index","name":"index","apis":[{"api_url":"/api/locations","http_method":"GET","short_description":"List all locations","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/update","name":"update","apis":[{"api_url":"/api/locations/:id","http_method":"PUT","short_description":"Update a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"location","full_name":"location","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"location[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"location[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"location[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"location[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"location[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"location[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"location[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"location[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"location[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"location[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"location[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"location[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"location[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"location[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"location[ignore_types]","description":"\n\u003cp\u003eList of resources types that will be automatically associated\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"location[organization_ids]","description":"\n\u003cp\u003eAssociated organization IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/locations/destroy","name":"destroy","apis":[{"api_url":"/api/locations/:id","http_method":"DELETE","short_description":"Delete a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"roles":{"doc_url":"../apidoc/v2/roles","id":"roles","api_url":"/api","name":"Roles","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/roles/index","name":"index","apis":[{"api_url":"/api/roles","http_method":"GET","short_description":"List all roles","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"builtin","values":["true","false"]},{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"permission","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/show","name":"show","apis":[{"api_url":"/api/roles/:id","http_method":"GET","short_description":"Show a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/create","name":"create","apis":[{"api_url":"/api/roles","http_method":"POST","short_description":"Create a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/update","name":"update","apis":[{"api_url":"/api/roles/:id","http_method":"PUT","short_description":"Update a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/destroy","name":"destroy","apis":[{"api_url":"/api/roles/:id","http_method":"DELETE","short_description":"Delete a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/roles/clone","name":"clone","apis":[{"api_url":"/api/roles/:id/clone","http_method":"POST","short_description":"Clone a role","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"role","full_name":"role","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"role[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"role[description]","description":"\n\u003cp\u003eRole description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"role[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"role[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"mail_notifications":{"doc_url":"../apidoc/v2/mail_notifications","id":"mail_notifications","api_url":"/api","name":"Mail notifications","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/mail_notifications/index","name":"index","apis":[{"api_url":"/api/mail_notifications","http_method":"GET","short_description":"List of email notifications","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"},{"name":"user","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/show","name":"show","apis":[{"api_url":"/api/mail_notifications/:id","http_method":"GET","short_description":"Show an email notification","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eNumerical ID or email notification name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/update","name":"update","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"PUT","short_description":"Update an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"interval","full_name":"interval","description":"\n\u003cp\u003eMail notification interval option, e.g. Daily, Weekly or Monthly. Required\nfor summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"subscription","description":"\n\u003cp\u003eMail notification subscription option, e.g. Subscribe, Subscribe to my\nhosts or Subscribe to all hosts. Required for host built and config error\nstate\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_query","full_name":"mail_query","description":"\n\u003cp\u003eRelevant only for audit summary notification\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/mail_notifications/:mail_notification_id","http_method":"DELETE","short_description":"Remove an email notification for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mail_notification_id","full_name":"mail_notification_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/mail_notifications/user_mail_notifications","name":"user_mail_notifications","apis":[{"api_url":"/api/users/:user_id/mail_notifications","http_method":"GET","short_description":"List all email notifications for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"media":{"doc_url":"../apidoc/v2/media","id":"media","api_url":"/api","name":"Media","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/media/index","name":"index","apis":[{"api_url":"/api/media","http_method":"GET","short_description":"List all installation media","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/media","http_method":"GET","short_description":"List all media for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/media","http_method":"GET","short_description":"List all media per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/media","http_method":"GET","short_description":"List all media per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"family","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"path","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/show","name":"show","apis":[{"api_url":"/api/media/:id","http_method":"GET","short_description":"Show a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/update","name":"update","apis":[{"api_url":"/api/media/:id","http_method":"PUT","short_description":"Update a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"medium[name]","description":"\n\u003cp\u003eName of media\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"medium[path]","description":"\n\u003cp\u003eThe path to the medium, can be a URL or a valid NFS server (exclusive of\nthe architecture).\u003c/p\u003e\n\n\u003cp\u003efor example \u003ca\nhref=\"http://mirror.centos.org/centos/$version/os/$arch\"\u003emirror.centos.org/centos/$version/os/$arch\u003c/a\u003e\nwhere $arch will be substituted for the host\u0026#39;s actual OS architecture\nand $version, $major and $minor will be substituted for the version of the\noperating system.\u003c/p\u003e\n\n\u003cp\u003eSolaris and Debian media may also use $release.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_family","full_name":"medium[os_family]","description":"\n\u003cp\u003eOperating system family, available values: AIX, Altlinux, Archlinux,\nCoreos, Debian, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Solaris,\nSuse, VRP, Windows, Xenserver\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_ids","full_name":"medium[operatingsystem_ids]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"medium[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"medium[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/media/destroy","name":"destroy","apis":[{"api_url":"/api/media/:id","http_method":"DELETE","short_description":"Delete a medium","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"models":{"doc_url":"../apidoc/v2/models","id":"models","api_url":"/api","name":"Models","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/models/index","name":"index","apis":[{"api_url":"/api/models","http_method":"GET","short_description":"List all hardware models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"hardware_model","type":"string"},{"name":"info","type":"text"},{"name":"name","type":"string"},{"name":"vendor_class","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/show","name":"show","apis":[{"api_url":"/api/models/:id","http_method":"GET","short_description":"Show a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/update","name":"update","apis":[{"api_url":"/api/models/:id","http_method":"PUT","short_description":"Update a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"model[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"info","full_name":"model[info]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vendor_class","full_name":"model[vendor_class]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hardware_model","full_name":"model[hardware_model]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/models/destroy","name":"destroy","apis":[{"api_url":"/api/models/:id","http_method":"DELETE","short_description":"Delete a hardware model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"table_preferences":{"doc_url":"../apidoc/v2/table_preferences","id":"table_preferences","api_url":"/api","name":"Table preferences","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/table_preferences/index","name":"index","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"GET","short_description":"List of table preferences for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/show","name":"show","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"GET","short_description":"Table preference details of a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/create","name":"create","apis":[{"api_url":"/api/users/:user_id/table_preferences","http_method":"POST","short_description":"Creates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/update","name":"update","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"PUT","short_description":"Updates a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"table_preferences","full_name":"table_preferences","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"table_preferences[name]","description":"\n\u003cp\u003eName of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"columns","full_name":"table_preferences[columns]","description":"\n\u003cp\u003eList of user selected columns\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/table_preferences/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/table_preferences/:name","http_method":"DELETE","short_description":"Delete a table preference for a given table","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n\u003cp\u003ename of the table\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"operatingsystems":{"doc_url":"../apidoc/v2/operatingsystems","id":"operatingsystems","api_url":"/api","name":"Operating systems","short_description":null,"full_description":"","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/operatingsystems/index","name":"index","apis":[{"api_url":"/api/operatingsystems","http_method":"GET","short_description":"List all operating systems","deprecated":null},{"api_url":"/api/architectures/:architecture_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested architecture","deprecated":null},{"api_url":"/api/media/:medium_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested medium","deprecated":null},{"api_url":"/api/ptables/:ptable_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested partition table","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/operatingsystems","http_method":"GET","short_description":"List all operating systems for nested provisioning template","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"architecture_id","full_name":"architecture_id","description":"\n\u003cp\u003eID of architecture\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium_id","full_name":"medium_id","description":"\n\u003cp\u003eID of medium\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ptable_id","full_name":"ptable_id","description":"\n\u003cp\u003eID of partition table\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"os_parameters_attributes","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"os_parameters_attributes[name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"os_parameters_attributes[value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"architecture","type":"string"},{"name":"description","type":"string"},{"name":"family","type":"string"},{"name":"major","type":"string"},{"name":"medium","type":"string"},{"name":"minor","type":"string"},{"name":"name","type":"string"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/create","name":"create","apis":[{"api_url":"/api/operatingsystems","http_method":"POST","short_description":"Create an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"PUT","short_description":"Update an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem","full_name":"operatingsystem","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must match regular expression \u003ccode\u003e/\\A(\\S+)\\Z/\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"major","full_name":"operatingsystem[major]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"minor","full_name":"operatingsystem[minor]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"operatingsystem[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family","full_name":"operatingsystem[family]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"release_name","full_name":"operatingsystem[release_name]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_parameters_attributes","full_name":"operatingsystem[os_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"operatingsystem[os_parameters_attributes][name]","description":"\n\u003cp\u003eName of the parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"operatingsystem[os_parameters_attributes][value]","description":"\n\u003cp\u003eParameter value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"password_hash","full_name":"operatingsystem[password_hash]","description":"\n\u003cp\u003eRoot password hash function to use\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eSHA256\u003c/code\u003e, \u003ccode\u003eSHA512\u003c/code\u003e, \u003ccode\u003eBase64\u003c/code\u003e, \u003ccode\u003eBase64-Windows\u003c/code\u003e, \u003ccode\u003eMD5\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture_ids","full_name":"operatingsystem[architecture_ids]","description":"\n\u003cp\u003eIDs of associated architectures\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"operatingsystem[provisioning_template_ids]","description":"\n\u003cp\u003eIDs of associated provisioning templates\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"operatingsystem[medium_ids]","description":"\n\u003cp\u003eIDs of associated media\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"operatingsystem[ptable_ids]","description":"\n\u003cp\u003eIDs of associated partition tables\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:id","http_method":"DELETE","short_description":"Delete an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/operatingsystems/bootfiles","name":"bootfiles","apis":[{"api_url":"/api/operatingsystems/:id/bootfiles","http_method":"GET","short_description":"List boot files for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"medium","full_name":"medium","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"architecture","full_name":"architecture","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"../apidoc/v2/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/organizations/index","name":"index","apis":[{"api_url":"/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"id","type":"integer"},{"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":"/api/organizations/:id","http_method":"GET","short_description":"Show 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/create","name":"create","apis":[{"api_url":"/api/organizations","http_method":"POST","short_description":"Create 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"organization[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"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":[]},{"name":"location_ids","full_name":"organization[location_ids]","description":"\n\u003cp\u003eAssociated location IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/update","name":"update","apis":[{"api_url":"/api/organizations/:id","http_method":"PUT","short_description":"Update 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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization","full_name":"organization","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"organization[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"organization[description]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_ids","full_name":"organization[user_ids]","description":"\n\u003cp\u003eUser IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_ids","full_name":"organization[smart_proxy_ids]","description":"\n\u003cp\u003eSmart proxy IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"compute_resource_ids","full_name":"organization[compute_resource_ids]","description":"\n\u003cp\u003eCompute resource IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"medium_ids","full_name":"organization[medium_ids]","description":"\n\u003cp\u003eMedium IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"ptable_ids","full_name":"organization[ptable_ids]","description":"\n\u003cp\u003ePartition template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_ids","full_name":"organization[provisioning_template_ids]","description":"\n\u003cp\u003eProvisioning template IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"organization[domain_ids]","description":"\n\u003cp\u003eDomain IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"realm_ids","full_name":"organization[realm_ids]","description":"\n\u003cp\u003eRealm IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_ids","full_name":"organization[hostgroup_ids]","description":"\n\u003cp\u003eHost group IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"environment_ids","full_name":"organization[environment_ids]","description":"\n\u003cp\u003eEnvironment IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"subnet_ids","full_name":"organization[subnet_ids]","description":"\n\u003cp\u003eSubnet IDs\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"parent_id","full_name":"organization[parent_id]","description":"\n\u003cp\u003eParent ID\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"ignore_types","full_name":"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":[]},{"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":[]}]},{"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, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/organizations/destroy","name":"destroy","apis":[{"api_url":"/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"settings":{"doc_url":"../apidoc/v2/settings","id":"settings","api_url":"/api","name":"Settings","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/settings/index","name":"index","apis":[{"api_url":"/api/settings","http_method":"GET","short_description":"List all settings","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"description","type":"text"},{"name":"name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/show","name":"show","apis":[{"api_url":"/api/settings/:id","http_method":"GET","short_description":"Show a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/settings/update","name":"update","apis":[{"api_url":"/api/settings/:id","http_method":"PUT","short_description":"Update a setting","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"setting","full_name":"setting","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"value","full_name":"setting[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"os_default_templates":{"doc_url":"../apidoc/v2/os_default_templates","id":"os_default_templates","api_url":"/api","name":"Os default templates","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/os_default_templates/index","name":"index","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"GET","short_description":"List default templates combinations for an operating system","deprecated":null},{"api_url":"/api/provisioning_templates/:provisioning_template_id/os_default_templates","http_method":"GET","short_description":"List operating systems where this template is set as a default","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"provisioning_template_id","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/create","name":"create","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates","http_method":"POST","short_description":"Create a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/update","name":"update","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"PUT","short_description":"Update a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"os_default_template","full_name":"os_default_template","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"template_kind_id","full_name":"os_default_template[template_kind_id]","description":"","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"provisioning_template_id","full_name":"os_default_template[provisioning_template_id]","description":"\n\u003cp\u003eID of provisioning template\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/os_default_templates/destroy","name":"destroy","apis":[{"api_url":"/api/operatingsystems/:operatingsystem_id/os_default_templates/:id","http_method":"DELETE","short_description":"Delete a default template combination for an operating system","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"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":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/tasks/index","name":"index","apis":[{"api_url":"/api/orchestration/:id/tasks","http_method":"GET","short_description":"List all tasks for a given orchestration event","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"override_values":{"doc_url":"../apidoc/v2/override_values","id":"override_values","api_url":"/api","name":"Override values","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/override_values/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"GET","short_description":"List of override values for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"GET","short_description":"Show an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/create","name":"create","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values","http_method":"POST","short_description":"Create an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"PUT","short_description":"Update an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value","full_name":"override_value","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"match","full_name":"override_value[match]","description":"\n\u003cp\u003eOverride match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"override_value[value]","description":"\n\u003cp\u003eOverride value, required if omit is false\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"override_value[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/override_values/destroy","name":"destroy","apis":[{"api_url":"/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id","http_method":"DELETE","short_description":"Delete an override value for a specific smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter_id","full_name":"smart_class_parameter_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"parameters":{"doc_url":"../apidoc/v2/parameters","id":"parameters","api_url":"/api","name":"Parameters","short_description":null,"full_description":"\n\u003cp\u003eThese API calls are related to \u003cstrong\u003enested parameters for a host,\ndomain, subnet, host group, operating system\u003c/strong\u003e. If you are looking\nfor \u0026lt;a href=“common_parameters.html”\u0026gt;global parameters\u0026lt;/a\u0026gt;, go\nto \u0026lt;a href=“common_parameters.html”\u0026gt;this link\u0026lt;/a\u0026gt;.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/parameters/index","name":"index","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"GET","short_description":"List all parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"GET","short_description":"List all parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"GET","short_description":"List all parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"GET","short_description":"List all parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"GET","short_description":"List all parameters for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"GET","short_description":"List all parameters for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"GET","short_description":"List all parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"domain_name","type":"string"},{"name":"host_group_name","type":"string"},{"name":"host_name","type":"string"},{"name":"key_type","type":"string"},{"name":"location_name","type":"string"},{"name":"name","type":"string"},{"name":"organization_name","type":"string"},{"name":"os_name","type":"string"},{"name":"parameter_type","type":"string"},{"name":"subnet_name","type":"text"},{"name":"type","type":"string"},{"name":"value","type":"text"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/show","name":"show","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"GET","short_description":"Show a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/create","name":"create","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"POST","short_description":"Create a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"POST","short_description":"Create a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/update","name":"update","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"PUT","short_description":"Update a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter","full_name":"parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"parameter[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"value","full_name":"parameter[value]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"parameter[parameter_type]","description":"\n\u003cp\u003eType of value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/destroy","name":"destroy","apis":[{"api_url":"/api/hosts/:host_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters/:id","http_method":"DELETE","short_description":"Delete a nested parameter for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of parameter\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/parameters/reset","name":"reset","apis":[{"api_url":"/api/hosts/:host_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a host group","deprecated":null},{"api_url":"/api/domains/:domain_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a domain","deprecated":null},{"api_url":"/api/operatingsystems/:operatingsystem_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for an operating system","deprecated":null},{"api_url":"/api/locations/:location_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for a location","deprecated":null},{"api_url":"/api/organizations/:organization_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameter for an organization","deprecated":null},{"api_url":"/api/subnets/:subnet_id/parameters","http_method":"DELETE","short_description":"Delete all nested parameters for a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"host_id","full_name":"host_id","description":"\n\u003cp\u003eID of host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"\n\u003cp\u003eID of host group\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"operatingsystem_id","full_name":"operatingsystem_id","description":"\n\u003cp\u003eID of operating system\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eID of location\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eID of organization\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_id","full_name":"subnet_id","description":"\n\u003cp\u003eID of subnet\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"permissions":{"doc_url":"../apidoc/v2/permissions","id":"permissions","api_url":"/api","name":"Permissions","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/permissions/index","name":"index","apis":[{"api_url":"/api/permissions","http_method":"GET","short_description":"List all permissions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"resource_type","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/permissions/show","name":"show","apis":[{"api_url":"/api/permissions/:id","http_method":"GET","short_description":"Show a permission","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_class_parameters":{"doc_url":"../apidoc/v2/smart_class_parameters","id":"smart_class_parameters","api_url":"/api","name":"Smart class parameters","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_class_parameters/index","name":"index","apis":[{"api_url":"/api/smart_class_parameters","http_method":"GET","short_description":"List all smart class parameters","deprecated":null},{"api_url":"/api/hosts/:host_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host","deprecated":null},{"api_url":"/api/hostgroups/:hostgroup_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific host group","deprecated":null},{"api_url":"/api/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific Puppet class","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment","deprecated":null},{"api_url":"/api/environments/:environment_id/puppetclasses/:puppetclass_id/smart_class_parameters","http_method":"GET","short_description":"List of smart class parameters for a specific environment/Puppet class combination","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"host_id","full_name":"host_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hostgroup_id","full_name":"hostgroup_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"puppetclass_id","full_name":"puppetclass_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"avoid_duplicates","values":["true","false"]},{"name":"environment","type":"string"},{"name":"key","type":"string"},{"name":"merge_default","values":["true","false"]},{"name":"merge_overrides","values":["true","false"]},{"name":"override","values":["true","false"]},{"name":"parameter","type":"string"},{"name":"puppetclass","type":"string"},{"name":"puppetclass_name","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/show","name":"show","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"GET","short_description":"Show a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden","full_name":"show_hidden","description":"\n\u003cp\u003eDisplay hidden values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_class_parameters/update","name":"update","apis":[{"api_url":"/api/smart_class_parameters/:id","http_method":"PUT","short_description":"Update a smart class parameter","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_class_parameter","full_name":"smart_class_parameter","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"override","full_name":"smart_class_parameter[override]","description":"\n\u003cp\u003eWhether the smart class parameter value is managed by Foreman\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"smart_class_parameter[description]","description":"\n\u003cp\u003eDescription of smart class\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"default_value","full_name":"smart_class_parameter[default_value]","description":"\n\u003cp\u003eValue to use when there is no match\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of types: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e","expected_type":"any_type","metadata":null,"show":true,"validations":[]},{"name":"hidden_value","full_name":"smart_class_parameter[hidden_value]","description":"\n\u003cp\u003eWhen enabled the parameter is hidden in the UI\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"omit","full_name":"smart_class_parameter[omit]","description":"\n\u003cp\u003eForeman will not send this parameter in classification output. Puppet will\nuse the value defined in the Puppet manifest for this parameter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"path","full_name":"smart_class_parameter[path]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_type","full_name":"smart_class_parameter[validator_type]","description":"\n\u003cp\u003eTypes of validation values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eregexp\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"validator_rule","full_name":"smart_class_parameter[validator_rule]","description":"\n\u003cp\u003eUsed to enforce certain values for the parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"override_value_order","full_name":"smart_class_parameter[override_value_order]","description":"\n\u003cp\u003eThe order in which values are resolved\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parameter_type","full_name":"smart_class_parameter[parameter_type]","description":"\n\u003cp\u003eTypes of variable values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003estring\u003c/code\u003e, \u003ccode\u003eboolean\u003c/code\u003e, \u003ccode\u003einteger\u003c/code\u003e, \u003ccode\u003ereal\u003c/code\u003e, \u003ccode\u003earray\u003c/code\u003e, \u003ccode\u003ehash\u003c/code\u003e, \u003ccode\u003eyaml\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"required","full_name":"smart_class_parameter[required]","description":"\n\u003cp\u003eIf true, will raise an error if there is no default value and no matcher\nprovide a value\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_overrides","full_name":"smart_class_parameter[merge_overrides]","description":"\n\u003cp\u003eMerge all matching values (only array/hash type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"merge_default","full_name":"smart_class_parameter[merge_default]","description":"\n\u003cp\u003eInclude default value when merging all matching values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"avoid_duplicates","full_name":"smart_class_parameter[avoid_duplicates]","description":"\n\u003cp\u003eRemove duplicate values (only array type)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"smart_proxies":{"doc_url":"../apidoc/v2/smart_proxies","id":"smart_proxies","api_url":"/api","name":"Smart proxies","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/smart_proxies/import_puppetclasses","name":"import_puppetclasses","apis":[{"api_url":"/api/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy","deprecated":null},{"api_url":"/api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null},{"api_url":"/api/environments/:environment_id/smart_proxies/:id/import_puppetclasses","http_method":"POST","short_description":"Import puppet classes from puppet proxy for an environment","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy_id","full_name":"smart_proxy_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"environment_id","full_name":"environment_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dryrun","full_name":"dryrun","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]},{"name":"except","full_name":"except","description":"\n\u003cp\u003eOptional comma-delimited string containing either \u0026#39;new\u0026#39;,\n\u0026#39;updated\u0026#39;, or \u0026#39;obsolete\u0026#39; that is used to limit the imported\nPuppet classes\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/index","name":"index","apis":[{"api_url":"/api/smart_proxies","http_method":"GET","short_description":"List all smart proxies","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"feature","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"name","type":"string"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"url","type":"string"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/show","name":"show","apis":[{"api_url":"/api/smart_proxies/:id","http_method":"GET","short_description":"Show a smart proxy","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"smart_proxy","full_name":"smart_proxy","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"smart_proxy[name]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"url","full_name":"smart_proxy[url]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"smart_proxy[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"smart_proxy[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/smart_proxies/refresh","name":"refresh","apis":[{"api_url":"/api/smart_proxies/:id/refresh","http_method":"PUT","short_description":"Refresh smart proxy features","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"ssh_keys":{"doc_url":"../apidoc/v2/ssh_keys","id":"ssh_keys","api_url":"/api","name":"Ssh keys","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/ssh_keys/index","name":"index","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"GET","short_description":"List all SSH keys for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"name","type":"string"},{"name":"user_id","type":"integer"}]},"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/show","name":"show","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"GET","short_description":"Show an SSH key from a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/create","name":"create","apis":[{"api_url":"/api/users/:user_id/ssh_keys","http_method":"POST","short_description":"Add an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ssh_key","full_name":"ssh_key","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"ssh_key[name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"key","full_name":"ssh_key[key]","description":"\n\u003cp\u003ePublic SSH key\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/ssh_keys/destroy","name":"destroy","apis":[{"api_url":"/api/users/:user_id/ssh_keys/:id","http_method":"DELETE","short_description":"Delete an SSH key for a user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"user_id","full_name":"user_id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null},"statistics":{"doc_url":"../apidoc/v2/statistics","id":"statistics","api_url":"/api","name":"Statistics","short_description":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it please install\nForeman Statistics plugin and use its API endpoints.\u003c/p\u003e\n","version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/statistics/index","name":"index","apis":[{"api_url":"/api/statistics","http_method":"GET","short_description":"Get statistics","deprecated":true}],"formats":null,"full_description":"\n\u003cp\u003eThis resource has been deprecated, to continue using it, install the\nForeman Statistics plugin.\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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":true},"subnets":{"doc_url":"../apidoc/v2/subnets","id":"subnets","api_url":"/api","name":"Subnets","short_description":null,"full_description":null,"version":"v2","formats":null,"metadata":null,"methods":[{"doc_url":"../apidoc/v2/subnets/index","name":"index","apis":[{"api_url":"/api/subnets","http_method":"GET","short_description":"List of subnets","deprecated":null},{"api_url":"/api/domains/:domain_id/subnets","http_method":"GET","short_description":"List of subnets for a domain","deprecated":null},{"api_url":"/api/locations/:location_id/subnets","http_method":"GET","short_description":"List of subnets per location","deprecated":null},{"api_url":"/api/organizations/:organization_id/subnets","http_method":"GET","short_description":"List of subnets per organization","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"domain_id","full_name":"domain_id","description":"\n\u003cp\u003eID of domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eScope by locations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eScope by organizations\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"search","full_name":"search","description":"\n\u003cp\u003efilter results\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"order","full_name":"order","description":"\n\u003cp\u003eSort field and order, eg. ‘id DESC’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number, starting at 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eNumber of results per page to return, \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":[]}],"returns":[],"examples":[],"metadata":{"search":[{"name":"boot_mode","type":"string"},{"name":"dns_primary","type":"string"},{"name":"dns_secondary","type":"string"},{"name":"domain","type":"string"},{"name":"gateway","type":"string"},{"name":"ipam","type":"string"},{"name":"location","type":"string"},{"name":"location_id","type":"integer"},{"name":"mask","type":"string"},{"name":"mtu","type":"integer"},{"name":"name","type":"text"},{"name":"network","type":"string"},{"name":"nic_delay","type":"integer"},{"name":"organization","type":"string"},{"name":"organization_id","type":"integer"},{"name":"params","type":"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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"show_hidden_parameters","full_name":"show_hidden_parameters","description":"\n\u003cp\u003eDisplay hidden parameter values\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/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":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/update","name":"update","apis":[{"api_url":"/api/subnets/:id","http_method":"PUT","short_description":"Update a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"subnet","full_name":"subnet","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"subnet[name]","description":"\n\u003cp\u003eSubnet name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"subnet[description]","description":"\n\u003cp\u003eSubnet description\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network_type","full_name":"subnet[network_type]","description":"\n\u003cp\u003eType or protocol, IPv4 or IPv6, defaults to IPv4\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eIPv4\u003c/code\u003e, \u003ccode\u003eIPv6\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"network","full_name":"subnet[network]","description":"\n\u003cp\u003eSubnet network\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"cidr","full_name":"subnet[cidr]","description":"\n\u003cp\u003eNetwork prefix in CIDR notation\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mask","full_name":"subnet[mask]","description":"\n\u003cp\u003eNetmask for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gateway","full_name":"subnet[gateway]","description":"\n\u003cp\u003eSubnet gateway\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_primary","full_name":"subnet[dns_primary]","description":"\n\u003cp\u003ePrimary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dns_secondary","full_name":"subnet[dns_secondary]","description":"\n\u003cp\u003eSecondary DNS for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ipam","full_name":"subnet[ipam]","description":"\n\u003cp\u003eIP Address auto suggestion mode for this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eDHCP\u003c/code\u003e, \u003ccode\u003eInternal DB\u003c/code\u003e, \u003ccode\u003eRandom DB\u003c/code\u003e, \u003ccode\u003eEUI-64\u003c/code\u003e, \u003ccode\u003eExternal IPAM\u003c/code\u003e, \u003ccode\u003eNone\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"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":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from","full_name":"subnet[from]","description":"\n\u003cp\u003eStarting IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"to","full_name":"subnet[to]","description":"\n\u003cp\u003eEnding IP Address for IP auto suggestion\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"vlanid","full_name":"subnet[vlanid]","description":"\n\u003cp\u003eVLAN ID for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mtu","full_name":"subnet[mtu]","description":"\n\u003cp\u003eMTU for this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"subnet[domain_ids]","description":"\n\u003cp\u003eDomains in which this subnet is part\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"dhcp_id","full_name":"subnet[dhcp_id]","description":"\n\u003cp\u003eDHCP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"tftp_id","full_name":"subnet[tftp_id]","description":"\n\u003cp\u003eTFTP Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"httpboot_id","full_name":"subnet[httpboot_id]","description":"\n\u003cp\u003eHTTPBoot Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"externalipam_id","full_name":"subnet[externalipam_id]","description":"\n\u003cp\u003eExternal IPAM Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dns_id","full_name":"subnet[dns_id]","description":"\n\u003cp\u003eDNS Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"template_id","full_name":"subnet[template_id]","description":"\n\u003cp\u003eTemplate HTTP(S) Proxy ID to use within this subnet\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"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":[]},{"name":"boot_mode","full_name":"subnet[boot_mode]","description":"\n\u003cp\u003eDefault boot mode for interfaces assigned to this subnet.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eStatic\u003c/code\u003e, \u003ccode\u003eDHCP\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subnet_parameters_attributes","full_name":"subnet[subnet_parameters_attributes]","description":"\n\u003cp\u003eArray of parameters (name, value)\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"location_ids","full_name":"subnet[location_ids]","description":"\n\u003cp\u003eREPLACE locations with given ids\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"organization_ids","full_name":"subnet[organization_ids]","description":"\n\u003cp\u003eREPLACE organizations with given ids.\u003c/p\u003e\n","required":false,"allow_nil":true,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/destroy","name":"destroy","apis":[{"api_url":"/api/subnets/:id","http_method":"DELETE","short_description":"Delete a subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"\n\u003cp\u003eSubnet numeric identifier\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a number.","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"../apidoc/v2/subnets/freeip","name":"freeip","apis":[{"api_url":"/api/subnets/:id/freeip","http_method":"GET","short_description":"Provides an unused IP address in this subnet","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eSet the current location context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"organization_id","full_name":"organization_id","description":"\n\u003cp\u003eSet the current organization context for the request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mac","full_name":"mac","description":"\n\u003cp\u003eMAC address to reuse the IP for this host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"excluded_ips","full_name":"excluded_ips","description":"\n\u003cp\u003eIP addresses that should be excluded from suggestion\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}},"link_extension":".html"}} \ No newline at end of file diff --git a/tests/fixtures/apidoc/organizations_role.json b/tests/fixtures/apidoc/organizations_role.json new file mode 120000 index 00000000..f9e40151 --- /dev/null +++ b/tests/fixtures/apidoc/organizations_role.json @@ -0,0 +1 @@ +foreman.json \ No newline at end of file From a017f0c1e415a84ba61de4113ee0f55e2fdab785 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Mon, 10 May 2021 11:50:31 +0200 Subject: [PATCH 51/56] host_errata_info module --- plugins/modules/host_errata_info.py | 117 ++++++ tests/fixtures/apidoc/host_errata_info.json | 1 + .../fixtures/host_errata_info-0.yml | 175 +++++++++ .../fixtures/host_errata_info-1.yml | 360 ++++++++++++++++++ tests/test_playbooks/host_errata_info.yml | 99 +++++ 5 files changed, 752 insertions(+) create mode 100644 plugins/modules/host_errata_info.py create mode 120000 tests/fixtures/apidoc/host_errata_info.json create mode 100644 tests/test_playbooks/fixtures/host_errata_info-0.yml create mode 100644 tests/test_playbooks/fixtures/host_errata_info-1.yml create mode 100644 tests/test_playbooks/host_errata_info.yml diff --git a/plugins/modules/host_errata_info.py b/plugins/modules/host_errata_info.py new file mode 100644 index 00000000..7d9c69ac --- /dev/null +++ b/plugins/modules/host_errata_info.py @@ -0,0 +1,117 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# (c) 2021 Evgeni Golov +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +DOCUMENTATION = ''' +--- +module: host_errata_info +version_added: 2.1.0 +short_description: Fetch information about Host Errata +description: + - Fetch information about Host Errata +author: + - "Evgeni Golov (@evgeni)" +options: + host: + description: + - Name of the host to fetch errata for. + required: true + type: str + content_view: + description: + - Calculate Applicable Errata based on a particular Content View. + - Required together with I(lifecycle_environment). + - If this is set, I(organization) also needs to be set. + required: false + type: str + lifecycle_environment: + description: + - Calculate Applicable Errata based on a particular Lifecycle Environment. + - Required together with I(content_view). + - If this is set, I(organization) also needs to be set. + required: false + type: str +extends_documentation_fragment: + - theforeman.foreman.foreman + - theforeman.foreman.foreman.infomodulewithoutname +''' + +EXAMPLES = ''' +- name: "List installable errata for host" + theforeman.foreman.host_errata_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + host: "host.example.com" + +- name: "List applicable errata for host" + theforeman.foreman.host_errata_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + organization: "Default Organization" + host: "host.example.com" + lifecycle_environment: "Library" + content_view: "Default Organization View" +''' + +RETURN = ''' +host_errata: + description: List of all found errata for the host and their details + returned: success + type: list + elements: dict +''' + +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( + ForemanInfoAnsibleModule +) + + +class ForemanHostErrataInfo(ForemanInfoAnsibleModule): + pass + + +def main(): + module = ForemanHostErrataInfo( + foreman_spec=dict( + name=dict(invisible=True), + host=dict(type='entity', required=True), + content_view=dict(type='entity', scope=['organization']), + lifecycle_environment=dict(type='entity', flat_name='environment_id', scope=['organization']), + ), + entity_opts=dict( + resource_type='host_errata', + ), + required_together=[ + ('content_view', 'lifecycle_environment'), + ], + required_by={ + 'content_view': 'organization', + 'lifecycle_environment': 'organization', + }, + ) + + with module.api_connection(): + module.run() + + +if __name__ == '__main__': + main() diff --git a/tests/fixtures/apidoc/host_errata_info.json b/tests/fixtures/apidoc/host_errata_info.json new file mode 120000 index 00000000..8e89899a --- /dev/null +++ b/tests/fixtures/apidoc/host_errata_info.json @@ -0,0 +1 @@ +katello.json \ No newline at end of file diff --git a/tests/test_playbooks/fixtures/host_errata_info-0.yml b/tests/test_playbooks/fixtures/host_errata_info-0.yml new file mode 100644 index 00000000..59c9c95d --- /dev/null +++ b/tests/test_playbooks/fixtures/host_errata_info-0.yml @@ -0,0 +1,175 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.0","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hosts?thin=true&search=name%3D%22foreman.example.com%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"foreman.example.com\\\ + \"\",\n \"sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\"\ + : [{\"id\":1,\"name\":\"foreman.example.com\"}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '258' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hosts/1/errata?per_page=4294967296 + response: + body: + string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":null,"sort":{"by":"updated","order":"desc"},"results":[{"id":8,"pulp_id":"RHEA-2012:0055","title":"Sea_Erratum","errata_id":"RHEA-2012:0055","issued":"2012-01-27","updated":"2012-01-27","severity":"","description":"Sea_Erratum","solution":"","summary":"","reboot_suggested":false,"uuid":"RHEA-2012:0055","name":"Sea_Erratum","type":"security","cves":[],"bugs":[],"hosts_available_count":1,"hosts_applicable_count":1,"packages":["penguin-0.9.1-1.noarch","shark-0.1-1.noarch","walrus-5.21-1.noarch"],"module_streams":[],"installable":true}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '619' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/host_errata_info-1.yml b/tests/test_playbooks/fixtures/host_errata_info-1.yml new file mode 100644 index 00000000..5f7befa5 --- /dev/null +++ b/tests/test_playbooks/fixtures/host_errata_info-1.yml @@ -0,0 +1,360 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.0","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-05-12 08:18:26 UTC\",\"updated_at\"\ + :\"2021-05-12 08:18:26 UTC\",\"id\":6,\"name\":\"Test Organization\",\"title\"\ + :\"Test Organization\",\"description\":\"A test organization\"}]\n}\n" + headers: + Cache-Control: + - max-age=0, private, must-revalidate + Connection: + - Keep-Alive + Content-Security-Policy: + - 'default-src ''self''; child-src ''self''; connect-src ''self'' ws: wss:; + img-src ''self'' data:; script-src ''unsafe-eval'' ''unsafe-inline'' ''self''; + style-src ''unsafe-inline'' ''self''' + Content-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hosts?thin=true&search=name%3D%22foreman.example.com%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 1,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"foreman.example.com\\\ + \"\",\n \"sort\": {\n \"by\": null,\n \"order\": null\n },\n \"results\"\ + : [{\"id\":1,\"name\":\"foreman.example.com\"}]\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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '258' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/6/content_views?search=name%3D%22Default+Organization+View%22&per_page=4294967296 + response: + body: + string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Default + Organization View\"","sort":{"by":"name","order":"asc"},"results":[{"composite":false,"component_ids":[],"default":true,"force_puppet_environment":false,"version_count":1,"latest_version":"1.0","auto_publish":false,"solve_dependencies":false,"import_only":false,"repository_ids":[],"id":5,"name":"Default + Organization View","label":"0d1cfe93-ce44-4f7e-b57b-93c874606b55","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2021-05-12 + 08:18:27 UTC","updated_at":"2021-05-12 08:18:27 UTC","environments":[{"id":5,"name":"Library","label":"Library","permissions":{"readable":true}}],"repositories":[],"puppet_modules":[],"versions":[{"id":5,"version":"1.0","published":"2021-05-12 + 08:18:27 UTC","environment_ids":[5]}],"components":[],"content_view_components":[],"activation_keys":[{"id":2,"name":"errata_key"}],"next_version":"1.0","last_published":"2021-05-12 + 08:18:27 UTC","permissions":{"view_content_views":true,"edit_content_views":true,"destroy_content_views":true,"publish_content_views":true,"promote_or_remove_content_views":true}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 6; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '1217' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/6/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":5,"name":"Library","label":"Library","description":null,"organization_id":6,"organization":{"name":"Test + Organization","label":"Test_Organization","id":6},"created_at":"2021-05-12 + 08:18:27 UTC","updated_at":"2021-05-12 08:18:27 UTC","prior":null,"successor":null,"counts":{"content_hosts":1,"content_views":0,"packages":32,"puppet_modules":0,"module_streams":0,"errata":{"security":3,"bugfix":0,"enhancement":1,"total":4},"yum_repositories":1,"docker_repositories":0,"ostree_repositories":0,"products":1},"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}}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 6; Test Organization + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '957' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/hosts/1/errata?content_view_id=5&environment_id=5&per_page=4294967296 + response: + body: + string: '{"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":null,"sort":{"by":"updated","order":"desc"},"results":[{"id":8,"pulp_id":"RHEA-2012:0055","title":"Sea_Erratum","errata_id":"RHEA-2012:0055","issued":"2012-01-27","updated":"2012-01-27","severity":"","description":"Sea_Erratum","solution":"","summary":"","reboot_suggested":false,"uuid":"RHEA-2012:0055","name":"Sea_Erratum","type":"security","cves":[],"bugs":[],"hosts_available_count":1,"hosts_applicable_count":1,"packages":["penguin-0.9.1-1.noarch","shark-0.1-1.noarch","walrus-5.21-1.noarch"],"module_streams":[],"installable":true}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=95 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '619' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/host_errata_info.yml b/tests/test_playbooks/host_errata_info.yml new file mode 100644 index 00000000..454b0647 --- /dev/null +++ b/tests/test_playbooks/host_errata_info.yml @@ -0,0 +1,99 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include: tasks/organization.yml + vars: + organization_state: present + - include: tasks/product.yml + vars: + product_state: present + - include: tasks/activation_key.yml + vars: + activation_key_name: errata_key + activation_key_content_view: Default Organization View + activation_key_lifecycle_environment: Library + activation_key_subscriptions: + - name: "Test Product" + - include: tasks/repository.yml + vars: + repository_state: present + repository_url: "https://jlsherrill.fedorapeople.org/fake-repos/needed-errata/" + - name: sync product + include_tasks: tasks/katello_sync.yml + +- hosts: foreman + become: true + tasks: + - name: install katello-ca-consumer + package: + name: http://localhost/pub/katello-ca-consumer-latest.noarch.rpm + - name: subscribe to katello + command: subscription-manager register --org="Test_Organization" --activationkey="errata_key" + - name: install buggy walrus + package: + name: walrus-0.71-1 + +- hosts: tests + gather_facts: false + collections: + - theforeman.foreman + vars_files: + - vars/server.yml + tasks: + - name: get errata info + host_errata_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + host: "{{ foreman_host }}" + register: errata + - name: check results + assert: + that: + - errata.host_errata | length == 1 + - errata.host_errata[0]['errata_id'] == 'RHEA-2012:0055' + + - name: get errata info with CV and LCE + host_errata_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + organization: "Test Organization" + host: "{{ foreman_host }}" + content_view: "Default Organization View" + lifecycle_environment: "Library" + register: errata + - name: check results + assert: + that: + - errata.host_errata | length == 1 + - errata.host_errata[0]['errata_id'] == 'RHEA-2012:0055' + +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include: tasks/activation_key.yml + vars: + activation_key_name: errata_key + activation_key_state: absent + - include_tasks: tasks/repository.yml + vars: + repository_state: absent + - include_tasks: tasks/product.yml + vars: + product_state: absent + - include_tasks: tasks/organization.yml + vars: + organization_state: absent +... From 0c6c764ddba5264c8c494e7f0b1b7a73d0625567 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Tue, 11 May 2021 14:11:51 +0200 Subject: [PATCH 52/56] subscription_info module --- plugins/modules/subscription_info.py | 81 ++++++++ tests/fixtures/apidoc/subscription_info.json | 1 + .../fixtures/subscription_info-0.yml | 182 ++++++++++++++++++ .../fixtures/subscription_info-1.yml | 120 ++++++++++++ tests/test_playbooks/subscription_info.yml | 64 ++++++ 5 files changed, 448 insertions(+) create mode 100644 plugins/modules/subscription_info.py create mode 120000 tests/fixtures/apidoc/subscription_info.json create mode 100644 tests/test_playbooks/fixtures/subscription_info-0.yml create mode 100644 tests/test_playbooks/fixtures/subscription_info-1.yml create mode 100644 tests/test_playbooks/subscription_info.yml diff --git a/plugins/modules/subscription_info.py b/plugins/modules/subscription_info.py new file mode 100644 index 00000000..5bd5f37a --- /dev/null +++ b/plugins/modules/subscription_info.py @@ -0,0 +1,81 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# (c) 2021 Evgeni Golov +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +DOCUMENTATION = ''' +--- +module: subscription_info +version_added: 2.1.0 +short_description: Fetch information about Subscriptions +description: + - Fetch information about Subscriptions +author: + - "Evgeni Golov (@evgeni)" +extends_documentation_fragment: + - theforeman.foreman.foreman + - theforeman.foreman.foreman.infomodule +''' + +EXAMPLES = ''' +- name: "Show a subscription" + theforeman.foreman.subscription_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + name: "Red Hat Satellite Infrastructure Subscription" + +- name: "Show all subscriptions with a certain name" + theforeman.foreman.subscription_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + search: name="Red Hat Satellite Infrastructure Subscription" +''' + +RETURN = ''' +subscription: + description: Details about the found subscription + returned: success and I(name) was passed + type: dict +subscriptions: + description: List of all found subscriptions and their details + returned: success and I(search) was passed + type: list + elements: dict +''' + +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ( + ForemanInfoAnsibleModule +) + + +class ForemanSubscriptionInfo(ForemanInfoAnsibleModule): + pass + + +def main(): + module = ForemanSubscriptionInfo() + + with module.api_connection(): + module.run() + + +if __name__ == '__main__': + main() diff --git a/tests/fixtures/apidoc/subscription_info.json b/tests/fixtures/apidoc/subscription_info.json new file mode 120000 index 00000000..8e89899a --- /dev/null +++ b/tests/fixtures/apidoc/subscription_info.json @@ -0,0 +1 @@ +katello.json \ No newline at end of file diff --git a/tests/test_playbooks/fixtures/subscription_info-0.yml b/tests/test_playbooks/fixtures/subscription_info-0.yml new file mode 100644 index 00000000..b711296f --- /dev/null +++ b/tests/test_playbooks/fixtures/subscription_info-0.yml @@ -0,0 +1,182 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.0","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + 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/subscriptions?search=name%3D%22Test+Product%22&per_page=4294967296 + response: + body: + string: '{"organization":{},"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":3,"cp_id":"4028fae1795b4f4201795fa3db630035","subscription_id":3,"name":"Test + Product","start_date":"2021-05-12 08:14:04 UTC","end_date":"2049-12-01 00:00:00 + UTC","available":-1,"quantity":-1,"consumed":0,"account_number":null,"contract_number":null,"support_level":null,"product_id":"677308081353","sockets":null,"cores":null,"ram":null,"instance_multiplier":1,"stacking_id":null,"multi_entitlement":false,"type":"NORMAL","product_name":"Test + Product","unmapped_guest":false,"virt_only":false,"virt_who":false,"upstream":false,"upstream_pool_id":null}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '728' + 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/subscriptions/3 + response: + body: + string: ' {"arch":"ALL","description":null,"support_type":null,"role":null,"usage":null,"addons":null,"id":3,"cp_id":"4028fae1795b4f4201795fa3db630035","subscription_id":3,"name":"Test + Product","start_date":"2021-05-12 08:14:04 UTC","end_date":"2049-12-01 00:00:00 + UTC","available":-1,"quantity":-1,"consumed":0,"account_number":null,"contract_number":null,"support_level":null,"product_id":"677308081353","sockets":null,"cores":null,"ram":null,"instance_multiplier":1,"stacking_id":null,"multi_entitlement":false,"type":"NORMAL","product_name":"Test + Product","unmapped_guest":false,"virt_only":false,"virt_who":false,"upstream":false,"upstream_pool_id":null,"host_count":0,"provided_products":[{"id":3,"name":"Test + Product"}],"activation_keys":[]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '741' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/subscription_info-1.yml b/tests/test_playbooks/fixtures/subscription_info-1.yml new file mode 100644 index 00000000..15b9b76b --- /dev/null +++ b/tests/test_playbooks/fixtures/subscription_info-1.yml @@ -0,0 +1,120 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.4.0","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + 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/subscriptions?search=name%3D%22Test+Product%22&per_page=4294967296 + response: + body: + string: '{"organization":{},"total":1,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Test + Product\"","sort":{"by":"name","order":"asc"},"results":[{"id":3,"cp_id":"4028fae1795b4f4201795fa3db630035","subscription_id":3,"name":"Test + Product","start_date":"2021-05-12 08:14:04 UTC","end_date":"2049-12-01 00:00:00 + UTC","available":-1,"quantity":-1,"consumed":0,"account_number":null,"contract_number":null,"support_level":null,"product_id":"677308081353","sockets":null,"cores":null,"ram":null,"instance_multiplier":1,"stacking_id":null,"multi_entitlement":false,"type":"NORMAL","product_name":"Test + Product","unmapped_guest":false,"virt_only":false,"virt_who":false,"upstream":false,"upstream_pool_id":null}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.4.0 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '728' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/subscription_info.yml b/tests/test_playbooks/subscription_info.yml new file mode 100644 index 00000000..3b056b50 --- /dev/null +++ b/tests/test_playbooks/subscription_info.yml @@ -0,0 +1,64 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include: tasks/organization.yml + vars: + organization_state: present + - include: tasks/product.yml + vars: + product_state: present + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: Fetch Subscription info + subscription_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + name: "Test Product" + register: sub + - name: check results + assert: + that: + - sub.subscription.name == 'Test Product' + - sub.subscription.product_name == 'Test Product' + + - name: Fetch Subscription info + subscription_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: "{{ foreman_validate_certs }}" + search: name="Test Product" + register: sub + - name: check results + assert: + that: + - sub.subscriptions[0].name == 'Test Product' + - sub.subscriptions[0].product_name == 'Test Product' + +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - include: tasks/product.yml + vars: + product_state: absent + - include: tasks/organization.yml + vars: + organization_state: absent +... From 71b36c7c90f6412803290fd8dbfa5593812cecfa Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Wed, 12 May 2021 12:28:52 +0200 Subject: [PATCH 53/56] add `sub_id` parameter for handling the Azure Subscription ID instead of the `user` parameter, which still works, but sub_id is preferred --- changelogs/fragments/azure-subid.yml | 2 ++ plugins/modules/compute_resource.py | 17 ++++++++++++++--- 2 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 changelogs/fragments/azure-subid.yml diff --git a/changelogs/fragments/azure-subid.yml b/changelogs/fragments/azure-subid.yml new file mode 100644 index 00000000..a88e7582 --- /dev/null +++ b/changelogs/fragments/azure-subid.yml @@ -0,0 +1,2 @@ +minor_changes: + - compute_resource - add ``sub_id`` parameter for handling the Azure Subscription ID instead of the ``user`` parameter diff --git a/plugins/modules/compute_resource.py b/plugins/modules/compute_resource.py index 8c0a054e..1c0906a4 100644 --- a/plugins/modules/compute_resource.py +++ b/plugins/modules/compute_resource.py @@ -122,6 +122,11 @@ - azurechina - azuregermancloud version_added: 2.1.0 + sub_id: + description: + - Subscription ID for I(provider=AzureRm) + type: str + version_added: 2.1.0 ssl_verify_peer: description: - verify ssl from provider I(provider=proxmox) @@ -312,7 +317,7 @@ - ACME provider: AzureRm provider_params: - user: SUBSCRIPTION_ID + sub_id: SUBSCRIPTION_ID tenant: TENANT_ID app_ident: CLIENT_ID password: CLIENT_SECRET @@ -378,7 +383,7 @@ def get_provider_info(provider): return 'EC2', ['user', 'password', 'region'] elif provider_name == 'azurerm': - return 'AzureRm', ['user', 'password', 'tenant', 'region', 'app_ident', 'cloud'] + return 'AzureRm', ['user', 'password', 'tenant', 'region', 'app_ident', 'cloud', 'sub_id'] elif provider_name == 'gce': return 'GCE', ['project', 'email', 'key_path', 'zone'] @@ -418,6 +423,7 @@ def main(): set_console_password=dict(invisible=True), keyboard_layout=dict(invisible=True), public_key=dict(invisible=True), + sub_id=dict(invisible=True), ), argument_spec=dict( provider_params=dict(type='dict', options=dict( @@ -442,7 +448,10 @@ def main(): keyboard_layout=dict(choices=['ar', 'de-ch', 'es', 'fo', 'fr-ca', 'hu', 'ja', 'mk', 'no', 'pt-br', 'sv', 'da', 'en-gb', 'et', 'fr', 'fr-ch', 'is', 'lt', 'nl', 'pl', 'ru', 'th', 'de', 'en-us', 'fi', 'fr-be', 'hr', 'it', 'lv', 'nl-be', 'pt', 'sl', 'tr']), public_key=dict(), - )), + sub_id=dict(), + ), + mutually_exclusive=[['user', 'sub_id']], + ), state=dict(type='str', default='present', choices=['present', 'absent', 'present_with_defaults']), ), required_if=( @@ -455,6 +464,8 @@ def main(): module.foreman_params['provider'], provider_param_keys = get_provider_info(provider=module.foreman_params['provider']) provider_params = module.foreman_params.pop('provider_params', {}) + if module.foreman_params['provider'] == 'AzureRm' and 'user' in provider_params: + provider_params['sub_id'] = provider_params.pop('user') for key in provider_param_keys: if key in provider_params: module.foreman_params[key] = provider_params.pop(key) From 16bc55dfdaae10f828414042432beb916b87bfd0 Mon Sep 17 00:00:00 2001 From: William Bradford Clark Date: Sat, 15 May 2021 01:57:40 -0400 Subject: [PATCH 54/56] Add repository_set_info module (#1189) * Add repository_set_info module * Add test playbook for repository_set_info module * Record test fixtures --- plugins/modules/repository_set_info.py | 101 ++++++ .../fixtures/apidoc/repository_set_info.json | 1 + .../fixtures/repository_set_info-0.yml | 306 ++++++++++++++++++ .../fixtures/repository_set_info-1.yml | 181 +++++++++++ tests/test_playbooks/repository_set_info.yml | 66 ++++ 5 files changed, 655 insertions(+) create mode 100644 plugins/modules/repository_set_info.py create mode 120000 tests/fixtures/apidoc/repository_set_info.json create mode 100644 tests/test_playbooks/fixtures/repository_set_info-0.yml create mode 100644 tests/test_playbooks/fixtures/repository_set_info-1.yml create mode 100644 tests/test_playbooks/repository_set_info.yml diff --git a/plugins/modules/repository_set_info.py b/plugins/modules/repository_set_info.py new file mode 100644 index 00000000..95d4b8a1 --- /dev/null +++ b/plugins/modules/repository_set_info.py @@ -0,0 +1,101 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +# (c) 2021 William Bradford Clark +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +DOCUMENTATION = ''' +--- +module: repository_set_info +version_added: 2.1.0 +short_description: Fetch information about Red Hat Repositories +description: + - Fetch information about Red Hat Repositories +author: "William Bradford Clark (@wbclark)" +options: + product: + description: + - Name of the parent product + required: false + type: str +extends_documentation_fragment: + - theforeman.foreman.foreman + - theforeman.foreman.foreman.katelloinfomodule + - theforeman.foreman.foreman.infomodule +''' + +EXAMPLES = ''' +- name: "Find repository set by name and product." + theforeman.foreman.repository_set_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + organization: "Default Organization" + name: "Red Hat Enterprise Linux 7 Server (RPMs)" + product: "Red Hat Enterprise Linux Server" + +- name: "Find repository set by label." + theforeman.foreman.repository_set_info: + username: "admin" + password: "changeme" + server_url: "https://foreman.example.com" + organization: "Default Organization" + search: 'label = "rhel-7-server-rpms"' +''' + +RETURN = ''' +repository_set: + description: Details about the found Red Hat Repository. + returned: success and I(name) was passed + type: dict +repository_sets: + description: List of all found Red Hat Repositories and their details. + returned: success and I(search) was passed + type: list + elements: dict +''' + + +from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import KatelloInfoAnsibleModule + + +class KatelloRepositorySetInfo(KatelloInfoAnsibleModule): + pass + + +def main(): + module = KatelloRepositorySetInfo( + foreman_spec=dict( + product=dict(type='entity', scope=['organization']), + ), + entity_opts={'scope': ['product']}, + required_together=[ + ['name', 'product'], + ], + ) + + # KatelloInfoAnsibleModule automatically adds organization to the entity scope + # but repository sets are scoped by product (and these are org scoped) + module.foreman_spec['entity']['scope'].remove('organization') + + with module.api_connection(): + module.run() + + +if __name__ == '__main__': + main() diff --git a/tests/fixtures/apidoc/repository_set_info.json b/tests/fixtures/apidoc/repository_set_info.json new file mode 120000 index 00000000..8e89899a --- /dev/null +++ b/tests/fixtures/apidoc/repository_set_info.json @@ -0,0 +1 @@ +katello.json \ No newline at end of file diff --git a/tests/test_playbooks/fixtures/repository_set_info-0.yml b/tests/test_playbooks/fixtures/repository_set_info-0.yml new file mode 100644 index 00000000..b8dc13ce --- /dev/null +++ b/tests/test_playbooks/fixtures/repository_set_info-0.yml @@ -0,0 +1,306 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-05-11 19:47:37 UTC\",\"updated_at\"\ + :\"2021-05-11 20:53:37 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations/3/products?search=name%3D%22Red+Hat+Enterprise+Linux+Server%22&per_page=4294967296 + response: + body: + string: '{"total":289,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux Server\"","sort":{"by":"name","order":"asc"},"results":[{"id":126,"cp_id":"69","name":"Red + Hat Enterprise Linux Server","label":"Red_Hat_Enterprise_Linux_Server","description":null,"provider_id":4,"sync_plan_id":1,"sync_summary":{},"gpg_key_id":null,"ssl_ca_cert_id":null,"ssl_client_cert_id":null,"ssl_client_key_id":null,"sync_state":null,"last_sync":"2021-05-11 + 19:48:52 UTC","last_sync_words":"about 1 hour","organization_id":3,"organization":{"name":"Test + Organization","label":"Test_Organization","id":3},"sync_plan":{"id":1,"name":"RHEL + Sync Plan","description":null,"sync_date":"2020-01-01 00:00:00 UTC","interval":"daily","next_sync":"2021-05-12 + 00:00:00 UTC","cron_expression":null},"repository_count":1}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '831' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/126/repository_sets?search=name%3D%22Red+Hat+Enterprise+Linux+7+Server+%28RPMs%29%22&per_page=4294967296 + response: + body: + string: '{"total":392,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"name=\"Red + Hat Enterprise Linux 7 Server (RPMs)\"","sort":{"by":"name","order":"asc"},"results":[{"enabled":true,"product":{"id":126,"name":"Red + Hat Enterprise Linux Server"},"repositories":[{"id":1,"name":"Red Hat Enterprise + Linux 7 Server RPMs x86_64 7Server","arch":"x86_64","releasever":"7Server"}],"name":"Red + Hat Enterprise Linux 7 Server (RPMs)","vendor":"Red Hat","label":"rhel-7-server-rpms","id":"2456","type":"yum","gpgUrl":"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release","contentUrl":"/content/dist/rhel/server/7/$releasever/$basearch/os"}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=97 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '641' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/products/126/repository_sets/2456 + response: + body: + string: ' {"enabled":true,"product":{"id":126,"name":"Red Hat Enterprise Linux + Server"},"repositories":[{"id":1,"name":"Red Hat Enterprise Linux 7 Server + RPMs x86_64 7Server","arch":"x86_64","releasever":"7Server"}],"name":"Red + Hat Enterprise Linux 7 Server (RPMs)","vendor":"Red Hat","label":"rhel-7-server-rpms","id":"2456","type":"yum","gpgUrl":"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release","contentUrl":"/content/dist/rhel/server/7/$releasever/$basearch/os"} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=96 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '462' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/fixtures/repository_set_info-1.yml b/tests/test_playbooks/fixtures/repository_set_info-1.yml new file mode 100644 index 00000000..f4150f5d --- /dev/null +++ b/tests/test_playbooks/fixtures/repository_set_info-1.yml @@ -0,0 +1,181 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/api/status + response: + body: + string: '{"result":"ok","status":200,"version":"2.3.3","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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=100 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '62' + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json;version=2 + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - apypie (https://github.com/Apipie/apypie) + method: GET + uri: https://foreman.example.org/katello/api/organizations?search=name%3D%22Test+Organization%22&per_page=4294967296 + response: + body: + string: "{\n \"total\": 2,\n \"subtotal\": 1,\n \"page\": 1,\n \"per_page\"\ + : 4294967296,\n \"search\": \"name=\\\"Test Organization\\\"\",\n \"sort\"\ + : {\n \"by\": null,\n \"order\": null\n },\n \"results\": [{\"label\"\ + :\"Test_Organization\",\"created_at\":\"2021-05-11 19:47:37 UTC\",\"updated_at\"\ + :\"2021-05-11 20:53:37 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - ; ANY + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=99 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '388' + 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/repository_sets?organization_id=3&search=label+%3D+%22rhel-7-server-rpms%22&per_page=4294967296 + response: + body: + string: '{"total":6445,"subtotal":1,"page":1,"per_page":"4294967296","error":null,"search":"label + = \"rhel-7-server-rpms\"","sort":{"by":"name","order":"asc"},"results":[{"enabled":true,"product":{"id":126,"name":"Red + Hat Enterprise Linux Server"},"repositories":[{"id":1,"name":"Red Hat Enterprise + Linux 7 Server RPMs x86_64 7Server","arch":"x86_64","releasever":"7Server"}],"name":"Red + Hat Enterprise Linux 7 Server (RPMs)","vendor":"Red Hat","label":"rhel-7-server-rpms","id":"2456","type":"yum","gpgUrl":"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release","contentUrl":"/content/dist/rhel/server/7/$releasever/$basearch/os"}]} + + ' + 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-Type: + - application/json; charset=utf-8 + Foreman_api_version: + - '2' + Foreman_current_location: + - ; ANY + Foreman_current_organization: + - 3; Test Organization + Foreman_version: + - 2.3.3 + Keep-Alive: + - timeout=15, max=98 + Strict-Transport-Security: + - max-age=631139040; includeSubdomains + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Download-Options: + - noopen + X-Frame-Options: + - sameorigin + X-Permitted-Cross-Domain-Policies: + - none + X-XSS-Protection: + - 1; mode=block + content-length: + - '623' + status: + code: 200 + message: OK +version: 1 diff --git a/tests/test_playbooks/repository_set_info.yml b/tests/test_playbooks/repository_set_info.yml new file mode 100644 index 00000000..774beb47 --- /dev/null +++ b/tests/test_playbooks/repository_set_info.yml @@ -0,0 +1,66 @@ +--- +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: ensure test organization + include_tasks: tasks/organization.yml + vars: + organization_name: "Test Organization" + organization_state: "present" + +- hosts: localhost + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + roles: + - role: content_rhel + vars: + foreman_organization: "Test Organization" + foreman_validate_certs: false + foreman_manifest_download: false + foreman_manifest_path: "{{ subscription_manifest_path }}" + foreman_content_rhel_enable_rhel7: true + foreman_content_rhel_enable_rhel8: false + foreman_content_rhel_sync_now: false + +- hosts: tests + collections: + - theforeman.foreman + gather_facts: false + vars_files: + - vars/server.yml + tasks: + - name: fetch RHEL 7 Server RPMs by product and name + repository_set_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: false + organization: "Test Organization" + product: "Red Hat Enterprise Linux Server" + name: "Red Hat Enterprise Linux 7 Server (RPMs)" + register: repository_set_info + - name: check repository_set details + assert: + that: + - repository_set_info['repository_set']['name'] == "Red Hat Enterprise Linux 7 Server (RPMs)" + + - name: fetch RHEL 7 Server RPMs by label + repository_set_info: + username: "{{ foreman_username }}" + password: "{{ foreman_password }}" + server_url: "{{ foreman_server_url }}" + validate_certs: false + organization: "Test Organization" + search: 'label = "rhel-7-server-rpms"' + register: repository_set_info + - name: check repository_set details + assert: + that: + - repository_set_info['repository_sets'][0]['name'] == "Red Hat Enterprise Linux 7 Server (RPMs)" From ebcdcc4e778220cad010e5bb36528dbc62faf45c Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Thu, 20 May 2021 12:08:26 +0200 Subject: [PATCH 55/56] release 2.1.0 --- .mailmap | 2 + CHANGELOG.rst | 37 +++++++++++ changelogs/changelog.yaml | 65 +++++++++++++++++++ .../fragments/1097-content-rhel-role.yml | 2 - .../fragments/1109-organizations-role.yml | 2 - .../fragments/1111-content_views_role.yml | 2 - changelogs/fragments/1116-hostgroups-role.yml | 2 - .../1123-ansible-roles-for-hostgroups.yml | 2 - .../1160-pass-image-in-compute-attributes.yml | 2 - .../1196-content_credentials-role.yml | 2 - changelogs/fragments/azure-clouds.yml | 2 - changelogs/fragments/azure-subid.yml | 2 - .../fragments/bz1885234-storage-lookup.yml | 2 - changelogs/fragments/domain-info-module.yml | 2 - changelogs/fragments/foreman-fact-upload.yml | 2 - changelogs/fragments/host-redfish-bmc.yml | 2 - .../fragments/subnet-bmc-proxy-param.yml | 2 - galaxy.yml | 6 +- 18 files changed, 109 insertions(+), 29 deletions(-) delete mode 100644 changelogs/fragments/1097-content-rhel-role.yml delete mode 100644 changelogs/fragments/1109-organizations-role.yml delete mode 100644 changelogs/fragments/1111-content_views_role.yml delete mode 100644 changelogs/fragments/1116-hostgroups-role.yml delete mode 100644 changelogs/fragments/1123-ansible-roles-for-hostgroups.yml delete mode 100644 changelogs/fragments/1160-pass-image-in-compute-attributes.yml delete mode 100644 changelogs/fragments/1196-content_credentials-role.yml delete mode 100644 changelogs/fragments/azure-clouds.yml delete mode 100644 changelogs/fragments/azure-subid.yml delete mode 100644 changelogs/fragments/bz1885234-storage-lookup.yml delete mode 100644 changelogs/fragments/domain-info-module.yml delete mode 100644 changelogs/fragments/foreman-fact-upload.yml delete mode 100644 changelogs/fragments/host-redfish-bmc.yml delete mode 100644 changelogs/fragments/subnet-bmc-proxy-param.yml diff --git a/.mailmap b/.mailmap index e8c4d12b..2fb0998d 100644 --- a/.mailmap +++ b/.mailmap @@ -14,3 +14,5 @@ Paul Gration Peter Ondrejka Richard Stempfl Richard Stempfl +Adam Růžička +Adam Růžička diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a395f486..369dc5d6 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -6,6 +6,43 @@ theforeman.foreman Release Notes This changelog describes changes after version 0.8.1. +v2.1.0 +====== + +Minor Changes +------------- + +- Add a domain_info module +- Add a hostgroups role (https://github.com/theforeman/foreman-ansible-modules/issues/1116) +- Add a role `content_rhel` to perform basic setup for registering and syncing RHEL content hosts +- Add content credentials role +- callback plugin - collect facts during the run, merge them correctly and upload them once at the end +- compute_resource - add ``cloud`` param for the AzureRm provider, to select which Azure cloud to use +- compute_resource - add ``sub_id`` parameter for handling the Azure Subscription ID instead of the ``user`` parameter +- host - Add ``Redfish`` to list of possible BMC providers of an interface +- host, compute_profile - look up the correct id for storage pods and domains given as part of ``volumes_attributes`` (https://bugzilla.redhat.com/show_bug.cgi?id=1885234) +- hostgroup - add a ``ansible_roles`` parameter (https://github.com/theforeman/foreman-ansible-modules/issues/1123) +- new ``content_views`` role to manage content views (https://github.com/theforeman/foreman-ansible-modules/issues/1111) +- new ``organizations`` role to manage organizations (https://github.com/theforeman/foreman-ansible-modules/issues/1109) +- subnet - add ``bmc_proxy`` parameter to configure BMC proxies for subnets + +Bugfixes +-------- + +- host - pass the right image id to the compute resource when creating a host (https://github.com/theforeman/foreman-ansible-modules/issues/1160, https://bugzilla.redhat.com/show_bug.cgi?id=1911670) + +New Modules +----------- + +- theforeman.foreman.content_view_info - Fetch information about Content Views +- theforeman.foreman.content_view_version_info - Fetch information about Content Views +- theforeman.foreman.domain_info - Fetch information about Domains +- theforeman.foreman.host_errata_info - Fetch information about Host Errata +- theforeman.foreman.repository_set_info - Fetch information about Red Hat Repositories +- theforeman.foreman.setting_info - Fetch information about Settings +- theforeman.foreman.subnet_info - Fetch information about Subnets +- theforeman.foreman.subscription_info - Fetch information about Subscriptions + v2.0.1 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index c9099a9a..16f52c8c 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -394,3 +394,68 @@ releases: - 1148-dont-filter-false-params.yml - 20210224-info_module_fixes.yml release_date: '2021-03-02' + 2.1.0: + changes: + bugfixes: + - host - pass the right image id to the compute resource when creating a host + (https://github.com/theforeman/foreman-ansible-modules/issues/1160, https://bugzilla.redhat.com/show_bug.cgi?id=1911670) + minor_changes: + - Add a domain_info module + - Add a hostgroups role (https://github.com/theforeman/foreman-ansible-modules/issues/1116) + - Add a role `content_rhel` to perform basic setup for registering and syncing + RHEL content hosts + - Add content credentials role + - callback plugin - collect facts during the run, merge them correctly and upload + them once at the end + - compute_resource - add ``cloud`` param for the AzureRm provider, to select + which Azure cloud to use + - compute_resource - add ``sub_id`` parameter for handling the Azure Subscription + ID instead of the ``user`` parameter + - host - Add ``Redfish`` to list of possible BMC providers of an interface + - host, compute_profile - look up the correct id for storage pods and domains + given as part of ``volumes_attributes`` (https://bugzilla.redhat.com/show_bug.cgi?id=1885234) + - hostgroup - add a ``ansible_roles`` parameter (https://github.com/theforeman/foreman-ansible-modules/issues/1123) + - new ``content_views`` role to manage content views (https://github.com/theforeman/foreman-ansible-modules/issues/1111) + - new ``organizations`` role to manage organizations (https://github.com/theforeman/foreman-ansible-modules/issues/1109) + - subnet - add ``bmc_proxy`` parameter to configure BMC proxies for subnets + fragments: + - 1097-content-rhel-role.yml + - 1109-organizations-role.yml + - 1111-content_views_role.yml + - 1116-hostgroups-role.yml + - 1123-ansible-roles-for-hostgroups.yml + - 1160-pass-image-in-compute-attributes.yml + - 1196-content_credentials-role.yml + - azure-clouds.yml + - azure-subid.yml + - bz1885234-storage-lookup.yml + - domain-info-module.yml + - foreman-fact-upload.yml + - host-redfish-bmc.yml + - subnet-bmc-proxy-param.yml + modules: + - description: Fetch information about Content Views + name: content_view_info + namespace: '' + - description: Fetch information about Content Views + name: content_view_version_info + namespace: '' + - description: Fetch information about Domains + name: domain_info + namespace: '' + - description: Fetch information about Host Errata + name: host_errata_info + namespace: '' + - description: Fetch information about Red Hat Repositories + name: repository_set_info + namespace: '' + - description: Fetch information about Settings + name: setting_info + namespace: '' + - description: Fetch information about Subnets + name: subnet_info + namespace: '' + - description: Fetch information about Subscriptions + name: subscription_info + namespace: '' + release_date: '2021-05-20' diff --git a/changelogs/fragments/1097-content-rhel-role.yml b/changelogs/fragments/1097-content-rhel-role.yml deleted file mode 100644 index b2ecfd3a..00000000 --- a/changelogs/fragments/1097-content-rhel-role.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Add a role `content_rhel` to perform basic setup for registering and syncing RHEL content hosts diff --git a/changelogs/fragments/1109-organizations-role.yml b/changelogs/fragments/1109-organizations-role.yml deleted file mode 100644 index 7d307e73..00000000 --- a/changelogs/fragments/1109-organizations-role.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - new ``organizations`` role to manage organizations (https://github.com/theforeman/foreman-ansible-modules/issues/1109) diff --git a/changelogs/fragments/1111-content_views_role.yml b/changelogs/fragments/1111-content_views_role.yml deleted file mode 100644 index 6d316918..00000000 --- a/changelogs/fragments/1111-content_views_role.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - new ``content_views`` role to manage content views (https://github.com/theforeman/foreman-ansible-modules/issues/1111) diff --git a/changelogs/fragments/1116-hostgroups-role.yml b/changelogs/fragments/1116-hostgroups-role.yml deleted file mode 100644 index 7203e01a..00000000 --- a/changelogs/fragments/1116-hostgroups-role.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Add a hostgroups role (https://github.com/theforeman/foreman-ansible-modules/issues/1116) diff --git a/changelogs/fragments/1123-ansible-roles-for-hostgroups.yml b/changelogs/fragments/1123-ansible-roles-for-hostgroups.yml deleted file mode 100644 index 0195b1c3..00000000 --- a/changelogs/fragments/1123-ansible-roles-for-hostgroups.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - hostgroup - add a ``ansible_roles`` parameter (https://github.com/theforeman/foreman-ansible-modules/issues/1123) diff --git a/changelogs/fragments/1160-pass-image-in-compute-attributes.yml b/changelogs/fragments/1160-pass-image-in-compute-attributes.yml deleted file mode 100644 index 98441ac3..00000000 --- a/changelogs/fragments/1160-pass-image-in-compute-attributes.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - host - pass the right image id to the compute resource when creating a host (https://github.com/theforeman/foreman-ansible-modules/issues/1160, https://bugzilla.redhat.com/show_bug.cgi?id=1911670) diff --git a/changelogs/fragments/1196-content_credentials-role.yml b/changelogs/fragments/1196-content_credentials-role.yml deleted file mode 100644 index 61a612d3..00000000 --- a/changelogs/fragments/1196-content_credentials-role.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Add content credentials role diff --git a/changelogs/fragments/azure-clouds.yml b/changelogs/fragments/azure-clouds.yml deleted file mode 100644 index 2595f82f..00000000 --- a/changelogs/fragments/azure-clouds.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - compute_resource - add ``cloud`` param for the AzureRm provider, to select which Azure cloud to use diff --git a/changelogs/fragments/azure-subid.yml b/changelogs/fragments/azure-subid.yml deleted file mode 100644 index a88e7582..00000000 --- a/changelogs/fragments/azure-subid.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - compute_resource - add ``sub_id`` parameter for handling the Azure Subscription ID instead of the ``user`` parameter diff --git a/changelogs/fragments/bz1885234-storage-lookup.yml b/changelogs/fragments/bz1885234-storage-lookup.yml deleted file mode 100644 index 293373e0..00000000 --- a/changelogs/fragments/bz1885234-storage-lookup.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - host, compute_profile - look up the correct id for storage pods and domains given as part of ``volumes_attributes`` (https://bugzilla.redhat.com/show_bug.cgi?id=1885234) diff --git a/changelogs/fragments/domain-info-module.yml b/changelogs/fragments/domain-info-module.yml deleted file mode 100644 index 016ea4c1..00000000 --- a/changelogs/fragments/domain-info-module.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - Add a domain_info module diff --git a/changelogs/fragments/foreman-fact-upload.yml b/changelogs/fragments/foreman-fact-upload.yml deleted file mode 100644 index fd73eaea..00000000 --- a/changelogs/fragments/foreman-fact-upload.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - callback plugin - collect facts during the run, merge them correctly and upload them once at the end diff --git a/changelogs/fragments/host-redfish-bmc.yml b/changelogs/fragments/host-redfish-bmc.yml deleted file mode 100644 index 91a81812..00000000 --- a/changelogs/fragments/host-redfish-bmc.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - host - Add ``Redfish`` to list of possible BMC providers of an interface diff --git a/changelogs/fragments/subnet-bmc-proxy-param.yml b/changelogs/fragments/subnet-bmc-proxy-param.yml deleted file mode 100644 index f211c07b..00000000 --- a/changelogs/fragments/subnet-bmc-proxy-param.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - subnet - add ``bmc_proxy`` parameter to configure BMC proxies for subnets diff --git a/galaxy.yml b/galaxy.yml index 1462ad40..f41c555e 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -2,6 +2,7 @@ namespace: "theforeman" name: "foreman" description: Ansible Modules to manage Foreman and Katello installations authors: + - "Adam Růžička " - "AlanCoding " - "Andrew Kofink " - "Anthony Green " @@ -11,6 +12,7 @@ authors: - "Bernhard Suttner " - "Bryan Kearney " - "Chris Forkner " + - "Chris Hindman " - "Chris Snell " - "Christoffer Reijer " - "Deric Crago " @@ -20,6 +22,7 @@ authors: - "Evgeni Golov " - "Ewoud Kohl van Wijngaarden " - "Greg Swift " + - "Hideki Saito " - "Ismael Puerto " - "Jameer Pathan " - "James Stuart " @@ -62,7 +65,8 @@ authors: - "metalcated " - "russianguppie <46544650+russianguppie@users.noreply.github.com>" - "willtome " -version: "2.1.0-dev" + - "yifatmakias " +version: "2.1.0" license: - "GPL-3.0-or-later" tags: From ac3ba24ff9e0a953b50111809b2417798dc2ff30 Mon Sep 17 00:00:00 2001 From: Evgeni Golov Date: Thu, 20 May 2021 15:00:58 +0200 Subject: [PATCH 56/56] update branding --- Makefile | 4 ++-- docs/cvmanager.md | 10 +++++----- tests/test_playbooks/fixtures/content_rhel_role-9.yml | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/Makefile b/Makefile index 9b420817..c9fbb77a 100644 --- a/Makefile +++ b/Makefile @@ -138,7 +138,7 @@ vendor: python vendor.py build/apypie-git/apypie/*.py > plugins/module_utils/_apypie.py branding: - sed -i 's/theforeman\.foreman/redhat.satellite/g' plugins/*/*.py tests/inventory/*.foreman.yml tests/test_module_state.py tests/test_playbooks/*.yml changelogs/config.yaml changelogs/changelog.yaml CHANGELOG.rst roles/*/README.md roles/*/*/*.yml docs/cvmanager.md + sed -i 's/theforeman\.foreman/redhat.satellite/g' plugins/*/*.py tests/inventory/*.foreman.yml tests/test_module_state.py tests/test_playbooks/*.yml changelogs/config.yaml changelogs/changelog.yaml CHANGELOG.rst roles/*/README.md roles/*/*/*.yml docs/cvmanager.md tests/test_playbooks/fixtures/*.yml sed -i 's/foreman.example.com/satellite.example.com/g' plugins/*/*.py docs/cvmanager.md roles/*/README.md roles/*/*/*.yml sed -i 's#theforeman/foreman-ansible-modules#RedHatSatellite/satellite-ansible-collection#g' .github/workflows/*.yml sed -i 's/theforeman-foreman/redhat-satellite/g' .github/workflows/*.yml @@ -146,7 +146,7 @@ branding: sed -i 's/The Foreman Project/Red Hat, Inc./g' docs/conf.py sed -i '/FOREMAN_\w/ s/FOREMAN_/SATELLITE_/g' plugins/doc_fragments/foreman.py plugins/module_utils/foreman_helper.py Makefile sed -i '/foreman_\w/ s/foreman_/satellite_/g' roles/*/README.md roles/*/*/*.yml - sed -i '/foreman_\w.*:/ s/foreman_/satellite_/g' tests/test_playbooks/*_role.yml + sed -i '/foreman_\w.*:/ s/foreman_/satellite_/g' tests/test_playbooks/*_role.yml docs/cvmanager.md rm -rf tests/test_playbooks/scc_* tests/test_playbooks/tasks/scc_* tests/test_playbooks/fixtures/scc_* plugins/modules/scc_*.py tests/fixtures/apidoc/scc_*.json rm -rf tests/test_playbooks/snapshot* tests/test_playbooks/tasks/snapshot* tests/test_playbooks/fixtures/snapshot* plugins/modules/snapshot.py tests/fixtures/apidoc/snapshot.json diff --git a/docs/cvmanager.md b/docs/cvmanager.md index 579f0b30..1ce0f8ae 100644 --- a/docs/cvmanager.md +++ b/docs/cvmanager.md @@ -15,11 +15,11 @@ To ease cleanup of old Content Views, we ship the `content_view_version_cleanup` roles: - role: redhat.satellite.content_view_version_cleanup vars: - foreman_server_url: https://satellite.example.com - foreman_username: "admin" - foreman_password: "changeme" - foreman_organization: "Default Organization" - foreman_content_view_version_cleanup_keep: 10 + satellite_server_url: https://satellite.example.com + satellite_username: "admin" + satellite_password: "changeme" + satellite_organization: "Default Organization" + satellite_content_view_version_cleanup_keep: 10 ``` ## Automated Updates diff --git a/tests/test_playbooks/fixtures/content_rhel_role-9.yml b/tests/test_playbooks/fixtures/content_rhel_role-9.yml index 91c6e3ab..f440fc0d 100644 --- a/tests/test_playbooks/fixtures/content_rhel_role-9.yml +++ b/tests/test_playbooks/fixtures/content_rhel_role-9.yml @@ -300,7 +300,7 @@ interactions: message: OK - request: body: '{"organization_id": 3, "name": "basic_rhel_key", "description": "Generated - by ansible role theforeman.foreman.content_rhel", "environment_id": 2, "content_view_id": + by ansible role redhat.satellite.content_rhel", "environment_id": 2, "content_view_id": 2}' headers: Accept: @@ -320,7 +320,7 @@ interactions: response: body: string: ' {"service_level":null,"content_overrides":[],"id":1,"name":"basic_rhel_key","description":"Generated - by ansible role theforeman.foreman.content_rhel","unlimited_hosts":true,"auto_attach":true,"content_view_id":2,"environment_id":2,"usage_count":0,"user_id":4,"max_hosts":null,"release_version":null,"purpose_usage":null,"purpose_role":null,"organization_id":3,"organization":{"name":"Test + by ansible role redhat.satellite.content_rhel","unlimited_hosts":true,"auto_attach":true,"content_view_id":2,"environment_id":2,"usage_count":0,"user_id":4,"max_hosts":null,"release_version":null,"purpose_usage":null,"purpose_role":null,"organization_id":3,"organization":{"name":"Test Organization","label":"Test_Organization","id":3},"created_at":"2021-03-18 16:17:02 UTC","updated_at":"2021-03-18 16:17:03 UTC","content_view":{"id":2,"name":"Default Organization View"},"environment":{"name":"Library","id":2},"products":[],"host_collections":[],"purpose_addons":[],"permissions":{"view_activation_keys":true,"edit_activation_keys":true,"destroy_activation_keys":true}}